Cancel Order
shopify.cancel_order
ActionBusiness appsconnection required
Calls the Shopify API with the connection's credentials.
Cancel a Shopify order, optionally restocking it and emailing the buyer.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Shopify
- Secret shape
- the Shopify Admin API access token
- Config it needs
- shop
- Resolved by
- config.connection_id, else node.connection_id
Configuration
4 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
order_id Numeric id of the order to act on. | string | Yes | — | — | 450789469 |
reason Why the order was cancelled. Shown in the Shopify admin. | string | No | — | one of "customer", "fraud", "inventory", "declined", "other" | — |
email Send the buyer a cancellation email. | boolean | No | — | — | — |
restock Return the cancelled items to inventory. Shopify marks this parameter deprecated but still honours it, and REST offers no replacement; the alternative is shopify.adjust_inventory_level after the cancel. | boolean | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"order_id": "450789469"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
order The cancelled order, as Shopify returned it. | object | — |
id Numeric id of the cancelled order, as a string. | string | — |
{
"id": "",
"order": {}
}Notes
- The store and the API version come from the connection: 'shop' (your-store.myshopify.com) and an optional 'api_version' that defaults to 2026-07. Auth is the Admin API access token, sent as X-Shopify-Access-Token.
- Lists page on an opaque cursor from Shopify's Link header, not on page numbers. Pass the 'page_info' a call returns back into the next call while 'has_more' is true; a request carrying page_info may only carry 'limit' and 'fields', so every other filter is ignored once you are paging.
- Shopify rate-limits with a leaky bucket (X-Shopify-Shop-Api-Call-Limit). A 429 fails the step with the bucket state and the Retry-After seconds in the message: put a control.delay in front of the node or lower 'limit'.
- Each write node also accepts the raw resource object for fields it does not model; that object is merged last and wins on a conflict.
- Cancelling is not deleting: the order stays in the store with a 'cancelled_at' timestamp. A fully fulfilled order cannot be cancelled.
See Cancel Order run in a workflow.
In a technical demo we add the Shopify connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.