Orders
Update order status
Moves an order under the same rules as the merchant dashboard. It never records a payment and never refunds.
PATCH/stores/{storeId}/v1/orders/{id}/status
completed closes a paid order and delivers any codes held for review. An unpaid order stays unpaid: moving it to processing or completed returns ORDER_NOT_PAID, and only the merchant can confirm a bank transfer. cancelled or returned on a completed order changes the status the merchant sees and moves no money. Refunds stay with the merchant. See Working with orders.
Path parameters
- idstringrequired
Request body
- statusstringrequired
- The status as the merchant sees it, under the same rules as the dashboard.
processingcompletedcancelledreturned
Response
- dataobjectrequired
- order_idstring
- statusstring
pendingprocessingcompletedcancelledreturned- payment_statusstring
unpaidpaidrefunded- updated_atstring (date-time)
- executionobject
- Who executed the request: the app, version, installation and store. Field names here are camelCase.
- appIdstring (uuid)
- versionIdstring (uuid)
- installationIdstring (uuid)
- storeIdstring (uuid)
- requestIdstring (uuid)
- generationinteger
- routeEpochinteger
- appAuthEpochinteger
- grantRevisioninteger
- metaobjectrequired
- request_idstring (uuid)
- The request ID; include it in any support request.
Errors
| HTTP | Code | Meaning |
|---|---|---|
| 404 | RESOURCE_NOT_FOUND | The ID does not exist in this store. |
| 409 | ORDER_NOT_PAID | The order is not paid, so it cannot move to processing or completed. |
| 409 | BANK_TRANSFER_CONFIRM_REQUIRED | The order waits for a bank transfer only the merchant can confirm. |
| 409 | ORDER_ADMINISTRATIVELY_CANCELLED | The merchant cancelled this completed order. Bring it back to completed first. |
| 409 | INVALID_ORDER_TRANSITION | The order cannot move from its current status to this one. |
| 409 | INVALID_ADMINISTRATIVE_TRANSITION | Only a paid order can change this way. |
| 409 | SHIPPING_IN_PROGRESS | A shipment is being created for this order. Wait for it to finish. |
| 409 | STORE_RULE_REFUSED | A store rule refused the command. Read the resource before you try again. |
| 422 | INVALID_ORDER_STATUS | Unknown status. |
| 403 | SCOPE_REQUIRED | The token does not carry the required scope. |
| 503 | APPS_SCOPE_RUNTIME_NOT_READY | The resource is not enabled on this merchant's store yet. |
Shared codes are listed in Errors.