CitrusAd only supports TSV format for order data. The table below describes the names of columns in a TSV file and their descriptions.
When syncing via TSV,
order_idmust be provided in sequential order, ensuring that if multiple products are purchased, they are attributed to the sameorder_Idat the same time.If
order_id’s are fragmented, subsequent products in the order will not be attributed.
Column names and descriptions for customer data in TSV files
| Column name | Required/optional | Data type | Description |
|---|---|---|---|
order_id | Required | Text | This is the identifier of the order in the retailer's system. MUST be ordered by orderId. |
order_date | Required | Text | This is the date or the date and time of the order. This must be in the format of ISO-8601 standard and must be a precise, full timestamp, e.g. 2019-03-14T15:06:17+10:00Must be in either timezone adjusted (+10:00 for UTC+10), or UTC time. |
product_code | Required | Text | This is the code to identify the product in the order. |
quantity | Required | Number | This is the quantity of the product in the order. This MUST be an integer number. |
regular_unit_price | Optional | Number | This is regular unit price of the product in the order. If provided, it MUST be a number. |
price_with_discounts | Required | Number | This is the total price of the products with discounts. It MUST be a number, e.g. if an order item contains 3 items with a price of 2.00, the value will be 6. |
customer_id | Optional | Text | This is the identifier of the customer of the order. |
session_id | Required. | Text | This is a generated id you control that identifies a user's session. CitrusAd can use this for purchase attribution. |
seller_id | Optional | Text | The unique Id of the seller. Only required if onboarding marketplace sellers. Can be left blank for non marketplace products. There are additional requirements to integrate seller_ids, please refer to Marketplace sellerId for more information. |
An example of a TSV file for customers can be seen in the table below. Similar to product data and customer data, the raw data is a text file, but it is represented in a table so we can read it easily.
order_id | order_date | product_code | quantity | regular_unit_price | price_with_discounts | customer_id | session_id | seller_id |
|---|---|---|---|---|---|---|---|---|
| 1343321 | 2019-03-15T17:06:17+00:06 | 357480 | 1 | 469 | 469 | 4234 | Z2YcoG5Pqe1uTCsz3Lk5WE3sBmExNjI4NjAxNDA | wde3e-sadet-d43 |
| 1343321 | 2019-03-15T17:06:17+00:06 | 4153234 | 4 | 47.95 | 191.8 | 4234 | Z2YcoG5Pqe1uTCsz3Lk5WE3sBmExNjI4NjAxNDA | |
| 1343321 | 2019-03-15T17:06:17+00:06 | 73553 | 1 | 6 | 6 | 4234 | Z2YcoG5Pqe1uTCsz3Lk5WE3sBmExNjI4NjAxNDA | |
| 6845359 | 2019-03-15T17:06:17+00:06 | 74549 | 3 | 6 | 18 | 2462 | 4fy5MPixTU-cKAWimSlHsLkfrUZCV1NfNzM1NTM= | |
| 6845360 | 2019-03-15T17:06:17+00:06 | 76542 | 2 | 11 | 22 | 4281 | IDI0Ks_vmSyeLUmDaa1UCCGJ_chCV1NfNzM1NTM= |
If you're unsure about the terms outlined in this section, please visit the reference page.