Batch Create

Input files

Your batch processing input files, uploaded to the input folder of your S3 bucket, must be Windows-1252 encoded and contain RFC 4180-compliant comma-separated values (CSV).

Use the following filename format:

{customer}-{action}-{timestamp}.csv

Where:

• customer is your organization name or a similar reference for your own use
• action describes the action or set of actions included in the file – see below. It doesn't need to match any action type names
• timestamp is a UTC datetime in the form YYYYMMDDHHMMSS

For example, MyReseller-CANCELLATIONS-20200902120000.csv.

Each input file must contain a header row, and up to 1,000 action rows. The header row defines the columns used by every action row.

There are five different types of actions. Four action types use the same columns (and can be included in the same input file or in separate files) and the fifth action type uses a different set of columns (and all actions of this type must be in the same input file, with no other action types). The table shows the actions and their columns:

Here are some example input files:

MyReseller-CREATIONS-20191012112013.csv

action,customerIdentifier,productKey,merchantAccountKey,notificationUrl,entitlementDisplayName,offerKey,dateExpiry,extensionData,extraInformation
CREATE,982516793869,BangoMusic,BANGO,https://www.bango.com,Entitlement1,TestOffer,2021-07-06T15:30:22Z,"""Param1"":""123"",""Param2"":""456""","""clientDevice"":{""type"":""STB"",""id"":""bc449c9e-406f-4399-a3ff-8671a27ac410"",""typeId"":""P49AJFND8NFN23NANGAJG"",""modelName"":""STB Model X7"",""modelNumber"":""IAH45IAOF5"",""serialNumber"":""JHFJHA43JNFA9393GFD"", ""osType"":""Linux"",""osVersion"":""10.3.8"",""macAddress"":""4A-0F-99-F2-D3-DD"",""browser"":""Firefox""},""communicationInformation"":{""emailAddress"":""123@abc.co.uk"",""msisdn"":441234567890},""source"":{""channelType"": ""WEB_PROMOTION"",""campaignRef"":""SUMMER_PROMO"",""referrer"":""SEARCH_ENGINE"",""bundleId"":""BundleABC123"",""country"":""United Kingdom"",""region"":""East Anglia"",""brand"":""BrandABC"",""serviceFlow"":""Activation""}"

Output files

The batch processing output files, stored in the output folder of your S3 bucket, are Windows-1252 encoded and contain RFC 4180-compliant comma-separated values (CSV).

Every output file includes the action in the first column, and all the fields of the affected entitlement record in the subsequent columns.

Here are some example output files:

MyReseller-CREATIONS-20191112112013.csv

action,entitlementId,customerIdentifier,productKey,entitlementDisplayName,offerKey,merchantAccountKey,activationCode,dateCreated,dateActivated,dateEnded,dateExpiry,dateFailed,dateSuspended,dateResumed,responseCode,responseMessage,status,parameters,extensionData,extraInformation
CREATE,dc48733b-a8a2-475a-8ff1-2dbe6716277e,982516793869,BangoMusic,Entitlement1,TestOffer,BANGO,,2019-10-10T10:21:08Z,,,2021-07-06T15:30:22Z,,,,CLIENT_ACTION_REQUIRED,An action is required to be performed by the client.,PENDING,"{""Action"":""NAVIGATE_TO_URL"",""Url"":""https://www.merchant.co.uk/token=580c14fc-4a24-4077-b030-ab5e22f5f03f""}","""Param1"":""123"",""Param2"":""456""","""clientDevice"":{""type"":""STB"",""id"":""bc449c9e-406f-4399-a3ff-8671a27ac410"",""typeId"":""P49AJFND8NFN23NANGAJG"",""modelName"":""STB Model X7"",""modelNumber"":""IAH45IAOF5"",""serialNumber"":""JHFJHA43JNFA9393GFD"", ""osType"":""Linux"",""osVersion"":""10.3.8"",""macAddress"":""4A-0F-99-F2-D3-DD"",""browser"":""Firefox""},""communicationInformation"":{""emailAddress"":""123@abc.co.uk"",""msisdn"":441234567890},""source"":{""channelType"": ""WEB_PROMOTION"",""campaignRef"":""SUMMER_PROMO"",""referrer"":""SEARCH_ENGINE"",""bundleId"":""BundleABC123"",""country"":""United Kingdom"",""region"":""East Anglia"",""brand"":""BrandABC"",""serviceFlow"":""Activation""}"