Skip to main content
Anchor to returnCancel

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

Anchor to Arguments

Arguments

Anchor to idid
•ID!
required

The ID of the return to cancel.

Anchor to notifyCustomernotifyCustomer
•Boolean
DeprecatedDefault:false
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?