Inkress DevelopersOrders · Update an order
API reference / Orders
Update an order
PUT/api/v1/orders/:idorders:write
Changes an order, for example marking it shipped. A status change sends the matching webhook, e.g. orders.shipped.
Path parameters
idintegerrequired
The order's ID.
Body
statusinteger
The new status, e.g. 7 shipped.
fulfillment_totalnumber
Delivery or shipping charge.
dataobject
Order details.
meta_dataobject
Your own extra data.
Headers
Authorizationheaderrequired
Bearer with your secret key, or the merchant's OAuth token.
Idempotency-Keyheader
For apps. Idempotent requests.
Returns
The updated order, with 201.
| 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. |
422 | A field is wrong, or the order's status can't change any more. |