Return

object

Requires read_returns access scope.

Represents a return.

Anchor to Fields and connectionsFields and connections

Anchor to declinedecline • ReturnDecline: Additional information about the declined return.
Anchor to exchangeLineItemsexchangeLineItems • ExchangeLineItemConnection!non-null: The exchange line items attached to the return.
Anchor to idid • 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 • RefundConnection!non-null: The list of refunds associated with the return.
Anchor to returnLineItemsreturnLineItems • ReturnLineItemTypeConnection!non-null: The return line items attached to the return.
Anchor to returnShippingFeesreturnShippingFees • [ReturnShippingFee!]!non-null: The return shipping fees for the return.
Anchor to reverseFulfillmentOrdersreverseFulfillmentOrders • ReverseFulfillmentOrderConnection!non-null: The list of reverse fulfillment orders for the return.
Anchor to statusstatus • ReturnStatus!non-null: The status of the return.
Anchor to suggestedRefundsuggestedRefund • SuggestedReturnRefund: A suggested refund for the return.
Anchor to totalQuantitytotalQuantity • Int!non-null: The sum of all return line item quantities for the return.

Was this section helpful?

Was this section helpful?

Anchor to returnApproveRequest returnApproveRequest • mutation: 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: 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: 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: Creates a return.
Anchor to returnDeclineRequest returnDeclineRequest • mutation: 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: Removes return lines from a return.
Anchor to returnReopen returnReopen • mutation: Reopens a closed return.
Anchor to returnRequest returnRequest • mutation: 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?

Was this section helpful?