propose_write

Cancel an order (pre-fulfilment; Shopify enforces the guard). Optionally refund and restock. Irreversible. Approval/auto

Cancel an order (pre-fulfilment; Shopify enforces the guard). Optionally refund and restock. Irreversible. Approval/auto-apply gated.

post/api/v1/tools/shopify_cancel_order

Request

  • Base URL: https://app.magistry.io
  • URL: https://app.magistry.io/api/v1/tools/shopify_cancel_order
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.magistry.io/api/oauth/authorize, token URL https://app.magistry.io/api/oauth/token, scopes: orders:write)

Request body

shopify_order_idinteger required
reason'CUSTOMER' | 'FRAUD' | 'INVENTORY' | 'DECLINED' | 'OTHER'
notify_customerboolean
refundboolean

Refund the payment (default true).

restockboolean

Restock the items (default true).

Response

Tool result

okboolean required
resultunknown required

Changes

No recorded changes to this operation across all 3 revisions of this API.