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
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
- Anchor to returnreturn•Return
The approved return.
- Anchor to userErrorsuser•[Return
Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •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•BooleanDeprecatedDefault:false
Customer
Arguments
- Anchor to returnreturn•Return
The canceled return.
- Anchor to userErrorsuser•[Return
Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •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
- Anchor to returnreturn•Return
The closed return.
- Anchor to userErrorsuser•[Return
Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •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
- Anchor to returnreturn•Return
The created return.
- Anchor to userErrorsuser•[Return
Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- 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
- Anchor to returnreturn•Return
The declined return.
- Anchor to userErrorsuser•[Return
Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Removes return lines from a return.
- Anchor to returnIdreturn•ID!required
Id 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
- Anchor to returnreturn•Return
The modified return.
- Anchor to userErrorsuser•[Return
Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Refunds a return when its status is
orand associates it with the related return request.- Anchor to returnRefundInputreturn•Return
Refund Input Refund Input!required The input fields to refund a return.
Arguments
- Anchor to refundrefund•Refund
The created refund.
- Anchor to userErrorsuser•[Return
Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Reopens a closed return.
- •ID!required
The ID of the return to reopen.
Arguments
- Anchor to returnreturn•Return
The reopened return.
- Anchor to userErrorsuser•[Return
Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
A customer's return request that hasn't been approved or declined. This mutation sets the value of the
Return.statusfield to. To create a return that has theReturn.statusfield set to, use themutation.- Anchor to inputinput•Return
Request Input!required The input fields for requesting a return.
Arguments
- Anchor to returnreturn•Return
The requested return.
- Anchor to userErrorsuser•[Return
Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Creates a new reverse delivery with associated external shipping information.
- Anchor to labelInputlabel•Reverse
Input Delivery Label InputDefault:null The return label file information for the reverse delivery.
- Anchor to notifyCustomernotify•BooleanDefault:true
Customer When
truethe customer is notified with delivery instructions if theis present.- 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 reverseFulfillmentOrderIdreverse•ID!required
Fulfillment Order Id The ID of the reverse fulfillment order that's associated to the reverse delivery.
- Anchor to trackingInputtracking•Reverse
Input Delivery Tracking InputDefault:null The tracking information for the reverse delivery.
Arguments
- Anchor to reverseDeliveryreverse•Reverse
Delivery Delivery The created reverse delivery.
- Anchor to userErrorsuser•[Return
Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates a reverse delivery with associated external shipping information.
- Anchor to labelInputlabel•Reverse
Input Delivery Label InputDefault:null The return label file information for the reverse delivery.
- Anchor to notifyCustomernotify•BooleanDefault:true
Customer If
trueand an email address exists on the, then the customer is notified with the updated delivery instructions.- Anchor to reverseDeliveryIdreverse•ID!required
Delivery Id The ID of the reverse delivery to update.
- Anchor to trackingInputtracking•Reverse
Input Delivery Tracking InputDefault:null The tracking information for the reverse delivery.
Arguments
- Anchor to reverseDeliveryreverse•Reverse
Delivery Delivery The updated reverse delivery.
- Anchor to userErrorsuser•[Return
Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •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
- Anchor to reverseFulfillmentOrderLineItemsreverse•[Reverse
Fulfillment Order Line Items Fulfillment Order Line Item!] The disposed reverse fulfillment order line items.
- Anchor to userErrorsuser•[Return
Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields