Syncing Order Data Via File

CitrusAd currently only support TSV format for Order data. The table below describes the names of columns in a TSV file and their descriptions. For order data, the columns that retailers must provide in a TSV file include “orderId”, “quantity”, “product_code”, “price_with_discounts”, “ad_id”, and “order_date”.

Column names and descriptions for customer data in TSV files

Column name

Required?

Datatype

Description

order_id

Required

Text

This is the identify of the order in the system of retailer.

customer_id

Optional

Text

This is the identify of the customer of the order

quantity

Required

Number

This is the quantity of the product in the order.

This must be a number.

product_code

Required

Text

This is the code to identify the product in the order.

regular_unit_price

Optional

Number

This is regular unit price of the product in the order.

If it is provided, it must be a number.

price_with_discounts

Required

Number

This is the price of the product with discounts. It must be a number.

ad_id

Optional

Text

This is the ad id for the order item. If an explicit associate between a single order item and a single ad id can be provided this field is used.

ad_ids

Optional

Text

This is an order level field that gathers all ad ids that should be associated with this order. If an explicit association between order items and ad ids can't be provide this field is used to provide the association at order level.

In TSV file, since each order item has its own row final set of ad_ids for the order would be calculated as the union of all order items ad_ids. This does not include explicit associations in ad_id field.

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.

For example: 2019-03-14T15:06:17+00:06 or 2019-03-14

session_id

Optional

Text

This is a generated id that you control that identifies a user's session. CitrusAd can use this for purchase attribution.

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 that we can read easily.

order_id

customer_id

quantity

product_code

price_with_discounts

ad_id

ad_ids

sessionId

order_date

1343321

5721

1

DM_357480

469

banner_Z2YcoG5Pqe1uTCsz3Lk5WE3sBmExNjI4NjAxNDA

2019-03-15

6845353

4234

4

4153234

191.8

display_4fy5MPixTU-cKAWimSlHsLkfrUZCV1NfNzM1NTM=

2019-03-15T17:06:17+00:06

6845358

4234

1

BWS_73553

6

display_IDI0Ks_vmSyeLUmDaa1UCCGJ_chCV1NfNzM1NTM=

2018-03-15T17:06:17+00:06

6845359

4234

3

BWS_74549

18

display_IDI054g4_vmSyeLUmDaa1UCCGJ_chCV1NfNzM1NTM, display_IDI0Ks_vmSyeLUmDaa1UCCfyn34ox8zn29rc3d44z8cn, banner_Z2YcoG5Pqe1uTCsz3Lkcxy342omcx4832mx4433x,

banner_33r3Csz3Lk5WE3sBmExNjI4x3yzcj38ccdh43ycxui3

2018-03-15T17:06:17+00:06

6845360

4281

2

BWS_76542

22

23dn3923-323d

2019-03-15T17:06:17+00:06