Order
Requires access scope or access scope.
Errors related to order cancellation.
Anchor to FieldsFields
- Anchor to codecode•Order
Cancel User Error Code The error code.
- Anchor to fieldfield•[String!]
The path to the input field that caused the error.
- Anchor to messagemessage•String!non-null
The error message.
Anchor to MutationsMutations
- •mutation
Cancels an order.
- Anchor to notifyCustomernotify•BooleanDefault:false
Customer Whether to send a notification to the customer about the order cancellation.
- Anchor to orderIdorder•ID!required
Id The ID of the order to be canceled.
- Anchor to reasonreason•Order
Cancel Reason!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 staffNotestaff•StringDefault:null
Note A staff-facing note about the order cancellation. This is not visible to the customer.
Arguments
- •Job
The job that asynchronously cancels the order.
- Anchor to orderCancelUserErrorsorder•[Order
Cancel User Errors Cancel User Error!]!non-null The list of errors that occurred from executing the mutation.
- Anchor to userErrorsuser•[User
Errors Error!]!non-nullDeprecated
Fields