returnCancel
mutation

Choose a version:

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).

Anchor to section titled 'Arguments'

Arguments

Anchor to id id ID! required: The ID of the return to cancel.

Was this section helpful?

Anchor to section titled 'ReturnCancelPayload returns'

ReturnCancelPayload returns

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

Was this section helpful?

Code examples for MUTATION: returnCancel

Query Reference for MUTATION: returnCancel

"mutation returnCancel($id: ID!) {\n  returnCancel(id: $id) {\n    return {\n      # Return fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: returnCancel

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

Schema Reference for MUTATION: returnCancel

""

Display Examples for MUTATION: returnCancel

[]

returnCancelmutation

Arguments

ReturnCancelPayload returns

returnCancel
mutation