OrderLineItem

A single line on a customer Order. May reference a product, a custom item, or a promotion — see type to disambiguate.

type OrderLineItem implements Node {
  id: ID!
  orderId: ID!
  productId: ID
  identifier: String!
  quantity: Int!
  label: String!
  unitPrice: Float
  totalPrice: Float
  description: String
  type: String
  shippedQuantity: Int
  order: Order
  product: Product
  parent: OrderLineItem
  children(
    first: Int = 10
    after: String
    filter: OrderLineItemFilterInput
  ): OrderLineItemConnection
}

Fields

OrderLineItem.id ● ID! non-null scalar

Global identifier for this entity.

OrderLineItem.orderId ● ID! non-null scalar

ID of the parent order.

OrderLineItem.productId ● ID scalar

ID of the referenced product when type = "product".

OrderLineItem.identifier ● String! non-null scalar

Stable identifier carried over from the cart line. Matches payload.identifier for promotion lines.

OrderLineItem.quantity ● Int! non-null scalar

Ordered quantity. Always positive.

OrderLineItem.label ● String! non-null scalar

Display label as shown to the customer at checkout. Frozen at order placement; subsequent product renames do not propagate.

OrderLineItem.unitPrice ● Float scalar

Gross unit price in the order's currency.

OrderLineItem.totalPrice ● Float scalar

Gross line total in the order's currency (unitPrice * quantity, minus per-line discounts).

OrderLineItem.description ● String scalar

Optional secondary description rendered below the label.

OrderLineItem.type ● String scalar

Line item type discriminator (product, custom, promotion, credit, …). Determines which other fields and references are meaningful.

OrderLineItem.shippedQuantity ● Int scalar

Number of units already shipped against this line. Equals quantity once the line is fully shipped.

OrderLineItem.order ● Order object

OrderLineItem.product ● Product object

OrderLineItem.parent ● OrderLineItem object

OrderLineItem.children ● OrderLineItemConnection object

OrderLineItem.children.first ● Int scalar

OrderLineItem.children.after ● String scalar

OrderLineItem.children.filter ● OrderLineItemFilterInput input

Interfaces

Node interface

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

Returned By

orderLineItem query

Member Of

OrderLineItem object ● OrderLineItemEdge object