Push Order Cancellation
POST/api/storefront/instances/:id/orders/:id2/push-cancellation
Tell the store to cancel this order now, instead of waiting for the next automatic run to push it. The store is asked to move the order to cancelled.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
422 when the store refuses — most often because it has already fulfilled the order; the message carries the store's own explanation.
The payload is the full order: every field from the list plus complete line objects (each with its SKU.io product link and, when the store product has been imported, its channel product link), the shipments SKU.io has pushed, the linked SKU.io sales order with its fulfillments, the shipments the store itself reports (store_fulfillments), and the stored store payload (raw_data). items_count is not included here — count items.
Requires the sales_orders.cancel permission.
Authentication: Bearer token (session or PAT).
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Content
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.