Cancel order
The Cancel order action cancels the order that triggers the workflow, and voids the authorization.
A second Cancel order (deprecated) action is temporarily available for using in workflows, and was previously used in Flow. This action does not void the authorization and uses a different API. It will be removed in the future.
Fields
The Cancel order action contains the following fields.
Field | Description |
---|---|
Send a notification to the customer | When checked, the workflow notifies the customer that their order has been canceled. |
Reason | Required. Indicates the reason for the cancellation of the order. By default, the reason is set to Customer changed/canceled order. |
Refund | When checked, refunds the amount paid by the customer, including charges for the product, duties, and shipping. |
Refund shipping & Refund items (deprecated) | A previous version of the Cancel order action showed options to separately Refund shipping and Refund items. |
Restock items | When checked, items from the order are returned to the store's inventory. |
Staff note | A staff note to show in the Admin timeline. |
Triggers
The Cancel order action has a hidden field added to it by the trigger. This field, Order ID (or order.id
), identifies the order to cancel. The order ID is set by default and can't be changed.
The Cancel order action can be used in workflows that start with the following triggers:
- Order canceled
- Order created
- Order fulfilled
- Order paid
- Order risk analyzed
- Order transaction created
- Fulfillment created
- Fulfillment event created
- Refund created
- Tender transaction created
Example
In this example workflow, an order is canceled when its risk level is high.
API details
To learn more, review the orderCancel API documentation.