Cancels a Shopify order and optionally restocks items and sends email notifications. Use when canceling an order that has not yet been paid or fulfilled. Orders cannot be cancelled if payment status is already paid or if the order has existing fulfillments.
emailbooleanWhether to send a cancellation email notification to the customer.
amountstringThe refund amount when canceling the order. Required for multi-currency orders along with currency.
reasonstringThe reason for canceling the order. Common values include 'customer', 'fraud', 'inventory', 'declined', 'other'.
refundobjectAn object containing detailed refund information. Should be generated using the Refund API's 'calculate' endpoint, specifying each line item with line_item_id, quantity, and restock_type.
restockbooleanWhether to restock the items from the canceled order back into inventory. Note: This parameter is deprecated but still functional.
currencystringThe currency code for the refund amount (e.g., 'USD', 'CAD'). Required when amount is specified in multi-currency scenarios.
order_idRequiredstringThe unique identifier of the order to cancel. Must use the order's API id, not order_number.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
OAuth connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.