Overview
Introduction
Our platform supports multiple methods for data integration through file transfers. You can share your data files in two ways:- Direct upload via sFTP
- Cloud storage integration (such as Azure Blob Storage)
Data Types
- Costs - Marketing costs data
- Indeliveries - Incoming products
- Inventory - Current stock levels and product attributes
- Orders - Customer transaction data
- Returns - Order return details
File name convention
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 specification
Technical Specification
| Category | Supported Options | Explanation |
|---|---|---|
| File Formats | .csv, .xls, .xlsx, .parquet | |
| Delimiters | Comma ,, Semicolon ; | |
| Decimal sign | Dot . | |
| Multiple values | "value1|value2|value3" | Separated by pipe | and wrapped in quotes " |
Schemas & Examples
Important: When importing examples into Google Sheets or similar tools, verify that numbers are not malformatted. Pay special attention to decimal points and thousand separators.
Costs
- Please reach out to commercial team for more info on the channel groups and channels.
- There is a possibility to map rows to different storefronts by country. In case you want that, we need information on how the mapping should look, see Merchant mappings.
| Column name | Format | Data Type | Description | Optional | Example |
|---|
Indeliveries
| Column name | Format | Data Type | Description | Optional | Example |
|---|
Inventory
| Column name | Format | Data Type | Description | Optional | Multiple | Example |
|---|
Orders
- Orders are matched on productId and variantId so we expect a unique combination of orderId-productId-variantId. If multiple items of the same variant were bought we expect them be aggregated with
quantity: number of items bought. - All prices should include tax.
- Order header level fields should be repeated for all items in the same order. If an item is returned or updated. we expect the original values for all columns except what has been updated (eg. the returned… fields or status line).
- If an order is updated, please fill out the
updatedAtfield and the fields that have been updated (eg. return details). - If you want data mapped to a specific storefront, fill out externalStorefrontId and provide us with info about your existing storefronts, see Merchant mappings.
| Column name | Format | Data Type | Description | Optional | Example | Default | |
|---|---|---|---|---|---|---|---|
| ⬆ |
Returns
Returns can be sent to us in three ways (listed in preferred order):- Part of orders, see Orders
- Separate file with an order reference, see Referenced return
- Separate file without an order reference, see Unreferenced return
returns. For details on the fields, please refer to Orders.
Referenced return
- 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:
orderId,productId,returnedQuantityDecimal,returnedAt,variantNo
externalStorefrontId,returnedReason,returnedShipmentStatus,returnedShipmentId,returnedShippingProvider,returnedWarehouse,warehouse
Unreferenced return
- Unreferenced returns are returns that cannot be linked to an original order. Without the original order context, some metrics like time-to-return and complete return rate calculations will be estimated and less accurate.
Please include as many fields from the Orders schema as possible to improve data matching and analytics.
returnId(replacesorderId, unique identifier for the return)currency,paidPrice,productId,returnedAt,returnedQuantityDecimal,tax,taxTotal,total,variantNo