Skip to main content
Anchor to orderCancel

orderCancel

mutation

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

Cancels an order.

Anchor to Arguments

Arguments

Anchor to notifyCustomernotifyCustomer
•BooleanDefault:false

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

Anchor to orderIdorderId
•ID!required

The ID of the order to be canceled.

Anchor to reasonreason
•OrderCancelReason!required

The reason for canceling the order.

Anchor to refundrefund
•Boolean!required

Indicates whether to refund the amount paid by the customer. Authorized payments will be voided regardless of this setting.

Anchor to restockrestock
•Boolean!required

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 staffNotestaffNote
•StringDefault:null

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

Was this section helpful?

Anchor to OrderCancelPayload returnsOrderCancelPayload returns

Anchor to jobjob
•Job

The job that asynchronously cancels the order.

Anchor to orderCancelUserErrorsorderCancelUserErrors
•[OrderCancelUserError!]!non-null

The list of errors that occurred from executing the mutation.

Anchor to userErrorsuserErrors
•[UserError!]!non-nullDeprecated

The list of errors that occurred from executing the mutation.

Was this section helpful?
OSZAR »