Skip to main content

ReturnOrderLineItem

A priced line of a ReturnOrder. Besides returned products, a return order also carries the order's discount and credit lines, so the refund of a discounted order is reduced by a line item of its own. quantity is the quantity that is refunded, announcedQuantity the quantity that is expected to arrive, and the remaining quantities report what actually arrived and what happened to it.

type ReturnOrderLineItem implements Node {
id: ID!
announcedQuantity: Int
disposedQuantity: Int
missingQuantity: Int
name: String!
orderLineItemId: ID
position: Int!
productId: ID
productNumber: String
quantity: Int!
reason: String!
reasonNote: String
restockedQuantity: Int
returnOrderId: ID!
returnedQuantity: Int
totalPrice: Float
type: String!
unitPrice: Float
goodsReceiptLineItems(
first: Int = 10
after: String
filter: GoodsReceiptLineItemFilterInput
): GoodsReceiptLineItemConnection
orderLineItem: OrderLineItem
product: Product
returnOrder: ReturnOrder
}

Fields​

ReturnOrderLineItem.id ● ID! non-null scalar​

Global identifier for this entity.

ReturnOrderLineItem.announcedQuantity ● Int scalar​

Quantity that is announced to arrive.

ReturnOrderLineItem.disposedQuantity ● Int scalar​

Quantity that was disposed instead of being moved back into stock, summed over the disposedQuantity of the goods receipt line items that received this line item.

ReturnOrderLineItem.missingQuantity ● Int scalar​

Announced quantity that has not arrived (yet): announcedQuantity minus returnedQuantity, never below zero.

ReturnOrderLineItem.name ● String! non-null scalar​

Label of the line item, captured when the line item was created.

ReturnOrderLineItem.orderLineItemId ● ID scalar​

ID of the order line item that is returned. Null for a line item without a reference to the order.

ReturnOrderLineItem.position ● Int! non-null scalar​

Position of the line item within its return order, starting at 1.

ReturnOrderLineItem.productId ● ID scalar​

ID of the returned product. Null for line items without a product, such as discounts, and for a product that was deleted.

ReturnOrderLineItem.productNumber ● String scalar​

Product number of the returned product, captured when the line item was created.

ReturnOrderLineItem.quantity ● Int! non-null scalar​

Quantity that is refunded. It can differ from the quantities that were announced or that arrived.

ReturnOrderLineItem.reason ● String! non-null scalar​

Technical name of the return reason, see ReturnReason.technicalName. unknown when no reason was given.

ReturnOrderLineItem.reasonNote ● String scalar​

Note the customer gave together with the reason, at most 255 characters. Null when the customer gave none.

ReturnOrderLineItem.restockedQuantity ● Int scalar​

Quantity that was moved back into stock, summed over the restockedQuantity of the goods receipt line items that received this line item. Together with disposedQuantity it stays below returnedQuantity while received units still wait in a goods receipt.

ReturnOrderLineItem.returnOrderId ● ID! non-null scalar​

ID of the return order the line item belongs to.

ReturnOrderLineItem.returnedQuantity ● Int scalar​

Quantity that arrived and was received with a goods receipt.

ReturnOrderLineItem.totalPrice ● Float scalar​

Refund amount of the line item in the order's currency.

ReturnOrderLineItem.type ● String! non-null scalar​

Type of the line item, taken from the order line item, e.g. product, promotion, credit or custom.

ReturnOrderLineItem.unitPrice ● Float scalar​

Refund amount per unit in the order's currency.

ReturnOrderLineItem.goodsReceiptLineItems ● GoodsReceiptLineItemConnection object​

ReturnOrderLineItem.goodsReceiptLineItems.first ● Int scalar​
ReturnOrderLineItem.goodsReceiptLineItems.after ● String scalar​
ReturnOrderLineItem.goodsReceiptLineItems.filter ● GoodsReceiptLineItemFilterInput input​

ReturnOrderLineItem.orderLineItem ● OrderLineItem object​

ReturnOrderLineItem.product ● Product object​

ReturnOrderLineItem.returnOrder ● ReturnOrder object​

Interfaces​

Node interface​

Any entity that can be loaded by its global id through the node(id: ID!) query.

Returned By​

returnOrderLineItem query

Member Of​

GoodsReceiptLineItem object ● ReturnOrderLineItemEdge object