Return
Requires access scope or access scope.
An item that a customer returns from a fulfilled order. Links to the original and tracks quantities through the return process.
The line item includes the customer's reason for returning the item and any additional notes. It also tracks processing status with separate quantities for items that are processable, processed, refundable, and refunded. You can apply optional restocking fees to cover handling costs.
Learn more about creating a return.
Anchor to FieldsFields
- Anchor to customerNotecustomer•String
Note A note from the customer that describes the item to be returned. Maximum length: 300 characters.
- Anchor to fulfillmentLineItemfulfillment•Fulfillment
Line Item Line Item! non-null The fulfillment line item from which items are returned.
- •ID!non-null
A globally-unique ID.
- Anchor to processableQuantityprocessable•Int!
Quantity non-null The quantity that can be processed.
- Anchor to processedQuantityprocessed•Int!
Quantity non-null The quantity that has been processed.
- Anchor to quantityquantity•Int!non-null
The quantity being returned.
- Anchor to refundableQuantityrefundable•Int!
Quantity non-null The quantity that can be refunded.
- Anchor to refundedQuantityrefunded•Int!
Quantity non-null The quantity that was refunded.
- Anchor to restockingFeerestocking•Restocking
Fee Fee The restocking fee for the return line item.
- Anchor to returnReasonDefinitionreturn•Return
Reason Definition Reason Definition The standardized reason for why the item is being returned.
- Anchor to returnReasonNotereturn•String!
Reason Note non-null Additional information about the reason for the return. Maximum length: 255 characters.
- Anchor to totalWeighttotal•Weight
Weight The total weight of the item.
- Anchor to unprocessedQuantityunprocessed•Int!
Quantity non-null The quantity that has't been processed.
- Anchor to withCodeDiscountedTotalPriceSetwith•Money
Code Discounted Total Price Set Bag! non-null The total line price after all discounts on the line item, including both line item level discounts and code-based line item discounts, are applied.
- Anchor to returnReasonreturn•Return
Reason Reason! non-nullDeprecated