PATCH
/api/v1/orders/{id}Advance order status
Move an order to the next state — processing → in_transit → delivered, or cancel. Same state machine as the dashboard; invalid transitions return 422.
Authorization
Requires the orders:write scope. See the auth guide for how to mint a token with the right scopes.
Parameters
Path parameters
| Field | Type | Description |
|---|---|---|
id required | string | Order CUID. e.g. cl9j4k2l3000001jx8h2zfb1m |
Body parameters
| Field | Type | Description |
|---|---|---|
to required | string | Target status. One of "processing", "in_transit", "delivered", "returned", "cancelled". e.g. in_transit |
carrier optional | string | Carrier label, set when moving to in_transit. e.g. Uber Direct |
trackingNumber optional | string | Carrier-issued tracking ref. e.g. UD-9182X |
Response
A successful call returns 200 OK with the body shown to the right. Errors follow the standard envelope.