Return
An error that occurs during the execution of a return mutation.
Anchor to FieldsFields
- Anchor to codecode•Return
Error Code The error code.
- Anchor to fieldfield•[String!]
The path to the input field that caused the error.
- Anchor to messagemessage•String!non-null
The error message.
Anchor to MutationsMutations
- •mutation
Removes return and/or exchange lines from a return.
- Anchor to returnIdreturn•ID!
Id required The ID of the return for line item removal.
- Anchor to returnLineItemsreturn•[Return
Line Items Line Item Remove From Return Input!] The return line items to remove from the return.
- Anchor to exchangeLineItemsexchange•[Exchange
Line Items Line Item Remove From Return Input!] The exchange line items to remove from the return.
Arguments
- •mutation
Approves a customer's return request. If this mutation is successful, then the
Return.statusfield of the approved return is set to.- Anchor to inputinput•Return
Approve Request Input! required The input fields to approve a return.
Arguments
- •mutation
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).
- •ID!required
The ID of the return to cancel.
- Anchor to notifyCustomernotify•Boolean
Customer DeprecatedDefault:false
Arguments
- •ID!
- •mutation
Indicates a return is complete, either when a refund has been made and items restocked, or simply when it has been marked as returned in the system.
- •ID!required
The ID of the return to close.
Arguments
- •ID!
- •mutation
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
state, 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
- Creates a sales agreement with a
reason, which links to all sales created for the return or exchange - Generates sales records that reverse the sales records for the items being returned
- Generates sales records for any exchange line items
After you've created a return, use the
returnquery to retrieve the return by its ID. Learn more about providing a return management workflow for merchants.- Anchor to returnInputreturn•Return
Input Input! required Specifies the input fields for a return.
Arguments
- Creates a return in the
- •mutation
Declines a return on an order. When a return is declined, each
can be associated to a new return. Use theormutation to initiate a new return.- Anchor to inputinput•Return
Decline Request Input! required The input fields for declining a customer's return request.
Arguments
- •mutation
Processes a return by confirming which items customers return and exchange, handling their disposition, and optionally issuing refunds. This mutation confirms the quantities for
andobjects previously created on theReturn.For returned items, you specify how to handle them through dispositions such as restocking or disposal. The mutation creates
objects for exchange items and records all transactions in the merchant's financial reports. You can optionally issue refunds through financial transfers, apply refund duties, and refund shipping costs.Learn more about processing returns.
- Anchor to inputinput•Return
Process Input! required Specifies the input fields for processing a return.
Arguments
- •mutation
Reopens a closed return.
- •ID!required
The ID of the return to reopen.
Arguments
- •ID!
- •mutation
Creates a return request that requires merchant approval before processing. The return has its status set to
and the merchant must approve or decline it.Use this mutation when customers initiate returns that need review. After creating a requested return, use
to approve it orto decline it.For returns that should be immediately open for processing, use the
mutation instead.Learn more about building return management workflows.
- Anchor to inputinput•Return
Request Input! required The input fields for requesting a return.
Arguments
- •mutation
Creates a new reverse delivery with associated external shipping information.
- Anchor to reverseFulfillmentOrderIdreverse•ID!
Fulfillment Order Id required The ID of the reverse fulfillment order that's associated to the reverse delivery.
- Anchor to reverseDeliveryLineItemsreverse•[Reverse
Delivery Line Items Delivery Line Item Input!]! required The reverse delivery line items to be created. If an empty array is provided, then this mutation will create a reverse delivery line item for each reverse fulfillment order line item, with its quantity equal to the reverse fulfillment order line item total quantity.
- Anchor to trackingInputtracking•Reverse
Input Delivery Tracking Input Default:null The tracking information for the reverse delivery.
- Anchor to labelInputlabel•Reverse
Input Delivery Label Input Default:null The return label file information for the reverse delivery.
- Anchor to notifyCustomernotify•Boolean
Customer Default:true When
truethe customer is notified with delivery instructions if theis present.
Arguments
- •mutation
Updates a reverse delivery with associated external shipping information.
- Anchor to reverseDeliveryIdreverse•ID!
Delivery Id required The ID of the reverse delivery to update.
- Anchor to trackingInputtracking•Reverse
Input Delivery Tracking Input Default:null The tracking information for the reverse delivery.
- Anchor to labelInputlabel•Reverse
Input Delivery Label Input Default:null The return label file information for the reverse delivery.
- Anchor to notifyCustomernotify•Boolean
Customer Default:true If
trueand an email address exists on the, then the customer is notified with the updated delivery instructions.
Arguments
- •mutation
Disposes reverse fulfillment order line items.
- Anchor to dispositionInputsdisposition•[Reverse
Inputs Fulfillment Order Dispose Input!]! required The input parameters required to dispose reverse fulfillment order line items.
Arguments
Deprecated mutations
- •mutationDeprecated
- Anchor to returnIdreturn•ID!
Id required The ID of the return for line item removal.
- Anchor to returnLineItemsreturn•[Return
Line Items Line Item Remove From Return Input!]! required The return line items to remove from the return.
Arguments
- •mutationDeprecated
- Anchor to returnRefundInputreturn•Return
Refund Input Refund Input! required The input fields to refund a return.
Arguments