Requires write_orders access scope. Also: This action cannot be reversed.

Cancels an order.


Anchor to notifyCustomer
notifyCustomer
default:false

Whether to send a notification to the customer about the order cancellation.

Anchor to orderId
orderId
required

The ID of the order to be canceled.

The reason for canceling the order.

Whether to refund the amount paid by the customer.

Whether to restock the inventory committed to the order. For unpaid orders fulfilled from locations that have been deactivated, inventory will not be restocked to the deactivated locations even if this argument is set to true.

Anchor to staffNote
staffNote
default:null

A staff-facing note about the order cancellation. This is not visible to the customer.


Was this section helpful?

The job that asynchronously cancels the order.

The list of errors that occurred from executing the mutation.

The list of errors that occurred from executing the mutation. Use orderCancelUserErrors instead.


Was this section helpful?