Anchor to section titled 'undefined'

Return
object

Requires read_returns access scope.

Represents a return.

Anchor to section titled 'Fields and connections'

Fields and connections

Anchor to Return.decline
decline
ReturnDecline

Additional information about the declined return.

Anchor to Return.exchangeLineItems
exchangeLineItems
Connection
ExchangeLineItemConnection!
non-null

The exchange line items attached to the return.

Anchor to Return.id
id
ID!
non-null

A globally-unique ID.

Anchor to Return.name
name
String!
non-null

The name of the return.

Anchor to Return.order
order
Order!
non-null

The order that the return belongs to.

Anchor to Return.refunds
refunds
Connection
RefundConnection!
non-null

The list of refunds associated with the return.

Anchor to Return.returnLineItems
returnLineItems
Connection
ReturnLineItemTypeConnection!
non-null

The return line items attached to the return.

Anchor to Return.returnShippingFees
returnShippingFees
[ReturnShippingFee!]!
non-null

The return shipping fees for the return.

Anchor to Return.reverseFulfillmentOrders
reverseFulfillmentOrders
Connection
ReverseFulfillmentOrderConnection!
non-null

The list of reverse fulfillment orders for the return.

Anchor to Return.status
status
ReturnStatus!
non-null

The status of the return.

Anchor to Return.suggestedRefund
suggestedRefund
SuggestedReturnRefund

A suggested refund for the return.

Anchor to Return.totalQuantity
totalQuantity
Int!
non-null

The sum of all return line item quantities for the return.

Was this section helpful?
Map

Fields and connections from

Return
Anchor to section titled 'Queries'

Queries

Anchor to return
return
query
Access requirements

Returns a Return resource by ID.

Was this section helpful?
<?>
Return Queries
Return

Queried by

Anchor to section titled 'Mutations'

Mutations

Anchor to returnApproveRequest
returnApproveRequest
mutation
Access requirements

Approves a customer's return request. If this mutation is successful, then the Return.status field of the approved return is set to OPEN.

Anchor to returnCancel
returnCancel
mutation
Access requirements

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 returnClose
returnClose
mutation
Access requirements

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.

Anchor to returnCreate
returnCreate
mutation
Access requirements

Creates a return.

Anchor to returnDeclineRequest
returnDeclineRequest
mutation
Access requirements

Declines a return on an order. When a return is declined, each ReturnLineItem.fulfillmentLineItem can be associated to a new return. Use the ReturnCreate or ReturnRequest mutation to initiate a new return.

Anchor to returnLineItemRemoveFromReturn
returnLineItemRemoveFromReturn
mutation
Access requirements

Removes return lines from a return.

Anchor to returnReopen
returnReopen
mutation
Access requirements

Reopens a closed return.

Anchor to returnRequest
returnRequest
mutation
Access requirements

A customer's return request that hasn't been approved or declined. This mutation sets the value of the Return.status field to REQUESTED. To create a return that has the Return.status field set to OPEN, use the returnCreate mutation.

Was this section helpful?
<~>
Return Mutations
Return

Mutated by

Anchor to section titled 'Implements'

Implements

Anchor to Node
Node
interface
Was this section helpful?
||-
Return Implements
Return

Implements