Orders · Get an order
API reference / Orders
Get an order
GET/api/v1/orders/:idorders:read
One order with its customer, merchant, lines and currency.
Path parameters
idintegerrequired
The order's ID.
Headers
Authorizationheaderrequired
Bearer with your secret key, or the merchant's OAuth token.
Returns
The order. status says where it is and kind what it is (1 online, 2 cart, 3 subscription, 4 invoice, 5 offline).
| 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. |
200 | result: false: there's no such object, or it isn't yours. |