Syncing order data via API
Syncing order data via backend (recommended)
To send order data to Epsilon Retail Media, use a command similar to the command below. Note that the data in the orders field below is dummy data, and is provided here only as an example. These examples all display the standard integration.
Single item orders
Below is the context for a customer who has purchased a single item:
POST $BASE_URL/v1/orders HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
"orders": [
{
"customerId": "npc-s243-ir",
"teamId": "9f48572c-0a5b-4997-9a0e-ed74f4d32dc6",
"sessionId": "5cat7-9964-4f",
"dtmcookieid": "DTM_COOKIE_ID",
"orderDate": "2021-12-02T15:00:00Z",
"id": "3h30e938-c158-4d78-a0af-b48bbwfrcss4",
"orderItems": [
{
"gtin": "9891998566P",
"quantity": 3,
"regularUnitPrice": 1.00,
"totalOrderItemPriceAfterDiscounts": 3.00,
"catalogId": "6adb93d0-7he4-4d4e-9b47-e5d3714c976a",
"citrusDiscountAmount": 0.0,
"substitutedFor": null,
"sellerId": "seller_id_601_64"
}
]
}
]
}If successful, the following object will be returned:
OrderDate format OrderDate in the format above is read as UTC time. You will need to synchronise in UTC.
Alternatively, you can set an offset for your timezone, subsituting Z for +HH:MM relevant to your timezone. For example: “orderDate”: “2021-12-02T15:00:00+10:00" will specify the timezone is UTC+10.
Multi-item orders
Below is the context for a customer who has purchased multiple items - there are multiple items in the orderItems array:
If successful, the following object will be returned:
Syncing multiple orders
If you are syncing multiple orders, you can send up to 100 items as a batch with each request. The number of requests you can make is unlimited. The payload order pushed is the same order as the result returned. This makes it possible for the data to remain congruent with the order representation in your backend.
If successful, the following object will be returned:
Marketplace sellerId
If you are onboarding marketplace sellers you need to synchronise the sellerId where applicable when reporting orders. In the event the purchased product does not have a sellerId, it can be omitted.
If you are not onboarding marketplace sellers, you do not need to specify sellerId in the order report
Below is an example of an order where one product is from a marketplace seller and another is not a marketplace product:
Retrieving order information
If you wish to verify order information within Epsilon Retail Media, you will make a GET request to the /orders/ API with the order id.
You will retrieve all information related to the order stored within the Epsilon Retail Media system. In the event the order is not found, it has likely not been ingested into the Epsilon Retail Media system.