Guide on integrating file-based data transfers with our platform.
Our platform supports multiple methods for data integration through file transfers. You can share your data files in two ways:
Once your files are uploaded, our system automatically processes and synchronizes the data, making it readily available for analytics and insights on our platform.
We expect the file to be named the following:
{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 |
---|
Example
Column name | Format | Data Type | Description | Optional | Example |
---|
Example
Column name | Format | Data Type | Description | Optional | Multiple | Example |
---|
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 | |
---|---|---|---|---|---|---|---|
⬆ |
Example
Returns can be sent to us in three ways (listed in preferred order):
The last two options can be sent individually or combined with the file type returns
. For details on the fields, please refer to Orders.
We expect the file to contain all items that have been returned between uploads (so if one file is sent every day, the file should contain only returns that happened the day before).
We expect a snapshot, that is, each row should have a unique combination of orderId-productId-variantNo. That is returned quantities should be aggregated, and all returned items from the same order should be included.
Example of referenced returns:
Required fields:
orderId
, productId
, returnedQuantityDecimal
, returnedAt
, variantNo
Optional fields:
externalStorefrontId
, returnedReason
, returnedShipmentStatus
, returnedShipmentId
, returnedShippingProvider
, returnedWarehouse
, warehouse
Required fields:
returnId
(replaces orderId
, unique identifier for the return)currency
, paidPrice
, productId
, returnedAt
, returnedQuantityDecimal
, tax
, taxTotal
, total
, variantNo
Example (combination of referenced and unreferenced returns)
For common issues and solutions, contact our support team directly for assistance.
Guide on integrating file-based data transfers with our platform.
Our platform supports multiple methods for data integration through file transfers. You can share your data files in two ways:
Once your files are uploaded, our system automatically processes and synchronizes the data, making it readily available for analytics and insights on our platform.
We expect the file to be named the following:
{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 |
---|
Example
Column name | Format | Data Type | Description | Optional | Example |
---|
Example
Column name | Format | Data Type | Description | Optional | Multiple | Example |
---|
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 | |
---|---|---|---|---|---|---|---|
⬆ |
Example
Returns can be sent to us in three ways (listed in preferred order):
The last two options can be sent individually or combined with the file type returns
. For details on the fields, please refer to Orders.
We expect the file to contain all items that have been returned between uploads (so if one file is sent every day, the file should contain only returns that happened the day before).
We expect a snapshot, that is, each row should have a unique combination of orderId-productId-variantNo. That is returned quantities should be aggregated, and all returned items from the same order should be included.
Example of referenced returns:
Required fields:
orderId
, productId
, returnedQuantityDecimal
, returnedAt
, variantNo
Optional fields:
externalStorefrontId
, returnedReason
, returnedShipmentStatus
, returnedShipmentId
, returnedShippingProvider
, returnedWarehouse
, warehouse
Required fields:
returnId
(replaces orderId
, unique identifier for the return)currency
, paidPrice
, productId
, returnedAt
, returnedQuantityDecimal
, tax
, taxTotal
, total
, variantNo
Example (combination of referenced and unreferenced returns)
For common issues and solutions, contact our support team directly for assistance.