Inkress DevelopersOrders · Order status
API reference / Orders
Order status
GET/api/v1/orders/status/:idno app scope
A public check of one order's status, for a thank-you page that polls. No key needed.
This endpoint answers
200 with state: "error" even when it finds the order; read result.result for the status. An ID that doesn't exist answers 500.Path parameters
idintegerrequired
The order's ID.
Returns
result.result is the order's status number and result.uid its invoice link's ID. The same object is repeated under data.
| status | Meaning |
|---|---|
1 | pending: waiting for the customer to pay. |
2 | error: the payment failed. |
3 | paid: orders.paid has been sent. |
Errors
500 | No order has this ID. |