To use our Sales Data Batch Loads solution, you need to format your sales data CSV file according to the specifications and guidelines described on this page.
General
- Your sales data file should be a simple
.csv
table, with each row describing the attributes of a single line item. - The name of the file has to match the pattern provided in the configuration.
- The extension of the file has to be
.csv
. - You cannot upload files larger than 100 GB.
- Use UTF-8 encoding.
- Your file must start with a header row (e.g. the field names). The columns in the header of your sales data file must be in the order that was specified during configuration.
- You can name the fields as you wish but they have to match your configuration.
- Order updates are not allowed. Make sure you upload each individual order only once, and do not reuse the same transaction ID and transaction type combination. In the case of duplicate records, new transactions will replace the previous ones.
- You need to load the full image of an order (not deltas) and make sure all the items included in a transaction are uploaded in the same file.
- Use any standard CSV separator to separate fields in a row, such as a comma '
,
', a semicolon ';
', a tab '\t
', a space ' ' and a pipe '|
'. - When using newline characters, make sure they are properly quoted.
- You can use single or double quotes.
- The optional fields must be included in the CSV file but their values can remain empty.
- Do not upload more than 20 custom fields.
Supported data types
The following data types are supported:
- string
- date
- float
- integer
Supported timestamp format
Sales Data Batch Loads supports a subset of ISO 8601:
- You need to provide time data with second precision.
- You can provide fractional second information up to 6 digits
- You need to provide timezone information:
- either provide UTC timestamps explicitly or
- use time with offsets.
Sales Data Batch Loads can process the following examples:
2022-06-16T12:18:51Z
2022-06-16T12:18:51.545Z
2024-04-11T07:00:24-07:00
2024-04-11T07:00:24.2-07:00
2022-06-16T12:18:51.123456Z
Invalid examples:
-
Wed Apr 16 2022 21:44:48 GMT-0400 (Eastern Daylight Saving Time)
: this example does not represent an ISO 8601 standard. -
2023-07-15 12:00:00.000000 UTC
: this example does not represent an ISO 8601 standard. -
2024-04-11
: this example does not contain time data and timezone information. -
2022-06-16T12:18:51.1234567Z
: more than 6 digits are used for fractional seconds in this example (Sales Data Batch Loads can process only 6 digits).
Custom fields
- A maximum of 20 custom fields can be uploaded.
- Custom fields are optional.
- The Sales Data Batch Loads solution also validates the data types of custom fields.
Example CSV
This is how a sample CSV file looks:
Click here to download the sample CSV file.
transactionType,transactionId,referencedOrderId,externalContactIdType,externalContactId,accountCurrency,transactionCurrency,transactionCreatedDateTime,transactionLastChangedDateTime,storeId,salesChannel,productId,quantity,amountInAccountCurrency,amountInTransactionCurrency,custom_color
order,123,123,email,3,EUR,EUR,2023-07-19T12:18:51.545Z,2023-07-20T12:18:51.545Z,12,online,111,1,120,120,black
order,234,234,email,3,EUR,EUR,2023-07-21T12:18:51.545Z,2023-07-22T12:18:51.545Z,12,online,222,5,1200,1200,orange
order,345,345,email,3,EUR,EUR,2023-07-23T12:18:51.545Z,2023-07-24T12:18:51.545Z,12,online,333,1.5,1200,1200,blue
order,456,456,email,3,EUR,EUR,2023-07-25T12:18:51.545Z,2023-07-26T12:18:51.545Z,12,online,444,140,1200,1200,purple
order,456,456,email,3,EUR,EUR,2023-07-25T12:18:51.545Z,2023-07-26T12:18:51.545Z,12,online,23,140,1200,1200,purple
Click to copy
Required fields
The following fields are required for Sales Data Batch Loads:
Field | Type | Necessity | Description |
transactionType | string | mandatory |
|
transactionId | string | mandatory |
|
referencedOrderId | string | mandatory for the type refund
|
|
externalContactIdType | string | mandatory |
|
externalContactId | string | mandatory |
|
account_currency | string | mandatory |
|
transaction_currency | string | mandatory | Currency in ISO format. |
transactionCreatedDateTime | timestamp | mandatory |
|
transactionLastChangedDateTime | timestamp | mandatory |
|
productId | string | mandatory |
|
quantity | float | mandatory |
|
amount_in_account_currency | float | mandatory |
|
amount_in_transaction_currency | float | mandatory |
|
Optional fields
The following fields are optional for Sales Data Batch Loads:
Field | Type | Necessity | Description |
storeId | string | optional |
|
salesChannel | string | optional |
|