> For the complete documentation index, see [llms.txt](https://help.citrusad.com/retail-media-interface/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.citrusad.com/retail-media-interface/integration/references/order-reference.md).

# Order reference

The below outlines the properties possible in a standard sync request as outlined in [Syncing order data via API](/retail-media-interface/integration/data-api/order-data-1/syncing-order-data-via-api.md).

## Request items

| Property                            | Description                                                                                                                                                                                                                                                                                                                                                       | Required/optional                  | Example                                                                                                                                             |
| ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `gtin`                              | This is the code to identify the product in the order.                                                                                                                                                                                                                                                                                                            | Required                           | `9891998566P`                                                                                                                                       |
| `id`                                | <p>This is the identifier of the order in the retailer's system.<br><br>If not provided, Epsilon Retail Media will generate an identifier.</p>                                                                                                                                                                                                                    | Optional.                          | `3h30e938-c158-4d78-a0af-b48bbwfrcss4`                                                                                                              |
| `orderDate`                         | <p>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.<br><br>Must be in UTC time, or timezone adjusted as per the example above.</p>                                                                                                      | Required                           | `2021-12-02T15:00:00Z`                                                                                                                              |
| `catalogId`                         | <p>The catalog ID you are syncing orders for. Useful for multi-retailer syncing via API.<br>Not applicable for file sync.</p>                                                                                                                                                                                                                                     | Optional                           | `6adb93d0-7he4-4d4e-9b47-e5d3714c976a`                                                                                                              |
| `orderItems`                        | An array of all items submitted within the order.                                                                                                                                                                                                                                                                                                                 | Required                           | `[<br> {<br> "gtin": "9891998566P",<br> "quantity": 3,<br> "regularUnitPrice": "1.00",<br> "totalOrderItemPriceAfterDiscounts": "3.00"<br> }<br> ]` |
| `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. Epsilon Retail Media 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`                          | <p>The unique Id of the seller. Only required if onboarding marketplace sellers. Can be left blank for non marketplace products.<br><br>There are additional requirements to integrate seller\_ids, please refer to <a href="/retail-media-interface/integration/feature-integrations/marketplace-sellerid.md">Marketplace sellerId</a> for more information.</p> | Optional                           | `73nns-32sxr-32ss` Custom per integration                                                                                                           |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.citrusad.com/retail-media-interface/integration/references/order-reference.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
