return
Requires access scope. Also: Available in an pre-authenticated state or fully authenticated state with a valid return id.
Returns a Return resource by ID. Apps using the Customer Account API must meet the protected customer data requirements.
Anchor to Possible returnsPossible returns
- Return (Return)
- Anchor to ReturnReturn•Return
A product return.
- Anchor to closedAtclosed•Date
At Time The date when the return was closed.
- Anchor to createdAtcreated•Date
At Time The date when the return was created.
- Anchor to exchangeLineItemsexchange•Exchange
Line Items Line Item Connection! non-null The exchange line items attached to the return.
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to includeRemovedItemsinclude•Boolean
Removed Items Default:false Include exchange line items that have been removed from the order by an order edit, return, etc. Items that have been removed have a zero (LineItem.currentQuantity).
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- •ID!non-null
A globally-unique ID.
- Anchor to namename•String!non-null
The name assigned to the return.
- Anchor to returnLineItemsreturn•Return
Line Items Line Item Type Connection! non-null The line items associated with the return.
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to returnLineItemsCountreturn•Count
Line Items Count The number of line items associated with the return.
- Anchor to reverseDeliveriesreverse•Reverse
Deliveries Delivery Connection! non-null The list of reverse deliveries associated with the return.
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to statusstatus•Return
Status! non-null The current status of the
Return.- Anchor to updatedAtupdated•Date
At Time The date when the return was last updated.