The below outlines the properties possible in a standard sync request as outlined in Syncing order data via API.
Request items
| Property | Description | Required/optional | Example |
|---|---|---|---|
gtin | This is the code to identify the product in the order. | Required | 9891998566P |
id | This is the identifier of the order in the retailer's system. If not provided, CitrusAd will generate an identifier. | Optional. | 3h30e938-c158-4d78-a0af-b48bbwfrcss4 |
orderDate | 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:00. Must be in UTC time, or timezone adjusted as per the example above. | Required | 2021-12-02T15:00:00Z |
catalogId | The catalog ID you are syncing orders for. Useful for multi-retailer syncing via API. Not applicable for file sync. | Optional | 6adb93d0-7he4-4d4e-9b47-e5d3714c976a |
orderItems | An array of all items submitted within the order. | Required | [ { "gtin": "9891998566P", "quantity": 3, "regularUnitPrice": "1.00", "totalOrderItemPriceAfterDiscounts": "3.00" } ] |
quantity | The quantity of products ordered | Required | 3 |
regularUnitPrice | The regular unit price of the product in the order. | Optional | 2.99 |
sessionId | This is a generated id you control that identifies a user's session. CitrusAd can use this for purchase attribution. | Required in a standard integration | 5cat7-9964-4f |
totalOrderItemPriceAfterDiscounts | This is the total price of the products with discounts. E.g. if an order item contains 3 items with a price of 2.00, the value will be 6.00. | Optional | 5.98 |
sellerId | 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. | Optional | 73nns-32sxr-32ss Custom per integration |