Orders · List orders
API reference / Orders
List orders
GET/api/v1/ordersorders:read
The merchant's orders, a page at a time. Filter on any field, e.g. status=3 or reference_id=order_1042.
Query parameters
pageinteger
Page number, from 1.
page_sizeinteger
Items per page.
orderstring
Sort, e.g. id desc for newest first.
statusinteger
Only orders with this status.
reference_idstring
Only the order with your reference.
Headers
Authorizationheaderrequired
Bearer with your secret key, or the merchant's OAuth token.
Returns
entries and pagination. Lists and filters.
| status | Meaning |
|---|---|
1 | pending: waiting for the customer to pay. |
2 | error: the payment failed. |
3 | paid: orders.paid has been sent. |
32 | partial: part of the total is paid. |
4 | confirmed: the merchant accepted it. |
5 | cancelled. |
6 | prepared: ready to ship or collect. |
7 | shipped. |
8 | delivered. |
9 | completed: delivered and confirmed. |
10 | returned. |
11 | refunded. |
12 | verifying: the merchant is checking it. |
13 | stale: pending for too long. |
14 | archived. |
Errors
401 | The key or token is missing, wrong or revoked, is for the other environment, or doesn't have the scope this endpoint needs. |