Order
Requires access scope or access scope. Also: The user requires access scope.
A job to determine the result of an order cancellation request.
Anchor to FieldsFields
- Anchor to donedone•Boolean!non-null
This indicates if the job is still queued or has been run.
- Anchor to errorserrors•[Order
Cancel User Error!]!non-null Returns any error that occurred during order cancellation.
- •ID!non-null
A globally-unique ID that's returned when running an asynchronous mutation.
- Anchor to orderorder•Order
The order associated with the cancellation request.
- Anchor to statusstatus•Order
Cancel Status!non-null The current status of the order cancellation request.
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 jobResultjob•Order
Result Cancel Job Result 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