returnCancel

mutation

Requires write_orders access scope or write_marketplace_orders access scope. Also: Requires the write_returns access scope. The user must have return_orders permission.

Cancels a return and restores the items back to being fulfilled. Canceling a return is only available before any work has been done on the return (such as an inspection or refund).

Arguments

Anchor to idid • ID!required: The ID of the return to cancel.
Anchor to notifyCustomernotifyCustomer • BooleanDeprecatedDefault:false: Whether the customer receives an email notification regarding the canceled return. Not supported. This argument will be removed in a future version.

Was this section helpful?

Anchor to ReturnCancelPayload returnsReturnCancelPayload returns

Anchor to returnreturn • Return: The canceled return.
Anchor to userErrorsuserErrors • [ReturnUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

1mutation returnCancel($id: ID!, $notifyCustomer: Boolean) {
2  returnCancel(id: $id, notifyCustomer: $notifyCustomer) {
3    return {
4      # Return fields
5    }
6    userErrors {
7      field
8      message
9    }
10  }
11}

Input

1{
2  "id": "gid://shopify/<objectName>/10079785100",
3  "notifyCustomer": true
4}

{
  "id": "gid://shopify/<objectName>/10079785100",
  "notifyCustomer": true
}