Return
Requires access scope.
Represents a return.
Anchor to Fields and connectionsFields and connections
- Anchor to declinedecline•Return
Decline Additional information about the declined return.
- Anchor to exchangeLineItemsexchange•Exchange
Line Items Line Item Connection!non-null The exchange line items attached to the return.
- •ID!non-null
A globally-unique ID.
- Anchor to namename•String!non-null
The name of the return.
- Anchor to orderorder•Order!non-null
The order that the return belongs to.
- Anchor to refundsrefunds•Refund
Connection!non-null The list of refunds associated with the return.
- Anchor to returnLineItemsreturn•Return
Line Items Line Item Type Connection!non-null The return line items attached to the return.
- Anchor to returnShippingFeesreturn•[Return
Shipping Fees Shipping Fee!]!non-null The return shipping fees for the return.
- Anchor to reverseFulfillmentOrdersreverse•Reverse
Fulfillment Orders Fulfillment Order Connection!non-null The list of reverse fulfillment orders for the return.
- Anchor to statusstatus•Return
Status!non-null The status of the return.
- Anchor to suggestedRefundsuggested•Suggested
Refund Return Refund A suggested refund for the return.
- Anchor to totalQuantitytotal•Int!non-null
Quantity The sum of all return line item quantities for the return.
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.
- 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
- •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
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