- Data is consumed and returned as JSON.
- Date(time)s are consumed and returned using the ISO 8601 format, specifically
yyyy-MM-ddTHH:mm:ssZ(UTC with zero offset).
Authentication requires the use of a unique supplier API-key over HTTP Basic Auth. In practice this means using your supplier API-key as the username and leaving the password blank.
You can make authenticated requests using a client (such as Postman or cURL) or manually.
To authenticate requests manually, Basic Auth requires the username and password to be separated by a colon (e.g. my-api-key:). This then needs to be base-64 encoded and included in the Authorization header, e.g. Authorization: Basic bXktYXBpLWtleQ==.
| Endpoint | Description | URL |
|---|---|---|
| getOrders | Returns orders created between the specified from and to parameters. |
/v0/orders?from={datetime}&to={datetime} |
| acknowledgeOrders | Mark orders as acknowledged | /v0/orders/acknowledge |
| updateStock | Updates one or more stock items. | /v0/inventory |
| updateShipments | Updates one or more shipments. | /v0/shipments |