Choose a version:

ReturnLineItemType

interface

Requires read_returns access scope or read_marketplace_returns access scope.

A return line item of any type.

Anchor to FieldsFields

Anchor to customerNotecustomerNote •String: A note from the customer that describes the item to be returned. Maximum length: 300 characters.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to processableQuantityprocessableQuantity •Int! non-null: The quantity that can be processed.
Anchor to processedQuantityprocessedQuantity •Int! non-null: The quantity that has been processed.
Anchor to quantityquantity •Int! non-null: The quantity being returned.
Anchor to refundableQuantityrefundableQuantity •Int! non-null: The quantity that can be refunded.
Anchor to refundedQuantityrefundedQuantity •Int! non-null: The quantity that was refunded.
Anchor to returnReasonreturnReason •ReturnReason! non-null: The reason for returning the item.
Anchor to returnReasonNotereturnReasonNote •String! non-null: Additional information about the reason for the return. Maximum length: 255 characters.
Anchor to unprocessedQuantityunprocessedQuantity •Int! non-null: The quantity that has't been processed.

Was this section helpful?

Anchor to Types implemented inTypes implemented in

Anchor to ReturnLineItem ReturnLineItem

•OBJECT

A return line item.

Anchor to customerNotecustomerNote •String: A note from the customer that describes the item to be returned. Maximum length: 300 characters.
Anchor to fulfillmentLineItemfulfillmentLineItem •FulfillmentLineItem! non-null: The fulfillment line item from which items are returned.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to processableQuantityprocessableQuantity •Int! non-null: The quantity that can be processed.
Anchor to processedQuantityprocessedQuantity •Int! non-null: The quantity that has been processed.
Anchor to quantityquantity •Int! non-null: The quantity being returned.
Anchor to refundableQuantityrefundableQuantity •Int! non-null: The quantity that can be refunded.
Anchor to refundedQuantityrefundedQuantity •Int! non-null: The quantity that was refunded.
Anchor to restockingFeerestockingFee •RestockingFee: The restocking fee for the return line item.
Anchor to returnReasonreturnReason •ReturnReason! non-null: The reason for returning the item.
Anchor to returnReasonNotereturnReasonNote •String! non-null: Additional information about the reason for the return. Maximum length: 255 characters.
Anchor to totalWeighttotalWeight •Weight: The total weight of the item.
Anchor to unprocessedQuantityunprocessedQuantity •Int! non-null: The quantity that has't been processed.
Anchor to withCodeDiscountedTotalPriceSetwithCodeDiscountedTotalPriceSet •MoneyBag! 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 UnverifiedReturnLineItem UnverifiedReturnLineItem

•OBJECT

An unverified return line item.

Anchor to customerNotecustomerNote •String: A note from the customer that describes the item to be returned. Maximum length: 300 characters.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to processableQuantityprocessableQuantity •Int! non-null: The quantity that can be processed.
Anchor to processedQuantityprocessedQuantity •Int! non-null: The quantity that has been processed.
Anchor to quantityquantity •Int! non-null: The quantity being returned.
Anchor to refundableQuantityrefundableQuantity •Int! non-null: The quantity that can be refunded.
Anchor to refundedQuantityrefundedQuantity •Int! non-null: The quantity that was refunded.
Anchor to returnReasonreturnReason •ReturnReason! non-null: The reason for returning the item.
Anchor to returnReasonNotereturnReasonNote •String! non-null: Additional information about the reason for the return. Maximum length: 255 characters.
Anchor to unitPriceunitPrice •MoneyV2! non-null: The unit price of the unverified return line item.
Anchor to unprocessedQuantityunprocessedQuantity •Int! non-null: The quantity that has't been processed.

Was this section helpful?

{

"customerNote": "",

"id": "",

"processableQuantity": "",

"processedQuantity": "",

"quantity": "",

"refundableQuantity": "",

"refundedQuantity": "",

"returnReason": "",

"returnReasonNote": "",

"unprocessedQuantity": ""

}

Variables

{
	"customerNote": "",
	"id": "",
	"processableQuantity": "",
	"processedQuantity": "",
	"quantity": "",
	"refundableQuantity": "",
	"refundedQuantity": "",
	"returnReason": "",
	"returnReasonNote": "",
	"unprocessedQuantity": ""
}

Schema

interface ReturnLineItemType {
  customerNote: String
  id: ID!
  processableQuantity: Int!
  processedQuantity: Int!
  quantity: Int!
  refundableQuantity: Int!
  refundedQuantity: Int!
  returnReason: ReturnReason!
  returnReasonNote: String!
  unprocessedQuantity: Int!
}