Guide on integrating file-based data transfers with our platform.
{merchant}_{dataType}_{date}.{fileFormat}
where:
merchant
= Company namedataType
= One of the values specified in Available Data Typesdate
= last date of data (normally ‘yesterday’ as it’s the last day containing a full day of data looking at today)fileFormat
= One of the values specified under Technical specificationCategory | Supported Options | Explanation |
---|---|---|
File Formats | .csv, .xls, .xlsx, .parquet | |
Delimiters | Comma , , Semicolon ; | |
Decimal sign | Dot . | |
Multiple values | " value1, value2, value3" | Separated by comma and wrapped in quotes |
Column name | Format | Data Type | Description | Optional | Example |
---|
Column name | Format | Data Type | Description | Optional | Example |
---|
Column name | Format | Data Type | Description | Optional | Multiple | Example |
---|
quantity: number of items bought
.updatedAt
field and the fields that have been updated (eg. return details).Column name | Format | Data Type | Description | Optional | Example | Default | |
---|---|---|---|---|---|---|---|
⬆ |
returns
. For details on the fields, please refer to Orders.
orderId
, productId
, returnedQuantityDecimal
, returnedAt
, variantNo
externalStorefrontId
, returnedReason
, returnedShipmentStatus
, returnedShipmentId
, returnedShippingProvider
, returnedWarehouse
, warehouse
returnId
(replaces orderId
, unique identifier for the return)currency
, paidPrice
, productId
, returnedAt
, returnedQuantityDecimal
, tax
, taxTotal
, total
, variantNo