return Create
Requires access scope or access scope.
Creates a return from an existing order that has at least one fulfilled line item that hasn't yet been refunded. If you create a return on an archived order, then the order is automatically unarchived.
Use the mutation when your workflow involves
approving or
declining requested returns
outside of the Shopify platform.
The mutation performs the following actions:
- Creates a return in the
OPENstate, and assumes that the return request from the customer has already been approved - Creates a reverse fulfillment order, and enables you to create a reverse delivery for the reverse fulfillment order
If the order has an existing write-off, calling this mutation can reduce the written-off amount automatically when it reduces the order total before write-offs below the remaining written-off amount.
After you've created a return, use the
return query to retrieve the
return by its ID. Learn more about providing a
return management workflow
for merchants.
Arguments
- returnInput (ReturnInput!)
- Anchor to returnInputreturn•Return
Input Input! required Specifies the input fields for a return.
Show input fields
- return (Return)
- userErrors ([ReturnUserError!]!)
- Anchor to returnreturn•Return
The created return.
Show fields
- Anchor to userErrorsuser•[Return
Errors User Error!]! non-null The list of errors that occurred from executing the mutation.
Show fields