API Endpoint specs | eRetail Audit Marketplace
Proposed API specifications for retailers, in order to consume data for Marketplace.
The data we can store is divided into 5 types (so we can consume 5 different endpoints):
Product sales data
Site pages data
Search terms data
Product availability data
Invoiced sales data
Retail media data
For example, we want to get sales information for a single date by making a GET request to a single endpoint, with date
, offset
and limit
parameters.
Specifically:
parameter | type | definition |
---|---|---|
|
(format: ‘yyyy-mm-dd’) | Return orders for the date requested |
|
| Limit orders returned based on the number specified |
|
| Offset orders returned based on the number specified |
We ideally want to get sales or other information for a single date by making a GET request to a single endpoint, with date, offset, and limit parameters (for pagination).
👉 Select an endpoint to view the documentation: