OrderLineItem

Object

Represents a line item in a order, which includes details about the product, variant, and any associated discounts.

Each line item contains information such as the product name, variant details, total price, and any applicable discounts. This allows for detailed tracking of items within a cart, including their pricing and discount applications.

Fields

discountApplications DiscountApplicationConnection!: Retrieves a paginated list of discount applications for a specific line item.
id ID!: The unique identifier of the line item.
metadata [MetadataItem!]!: Gets the metadata associated with the order line item.
product Product: This retrieves the product associated with a cart line item. If the product no longer exists—such as if it has been removed from the channel or deleted entirely—this will return null. In such cases, you can still use other properties like productName and productSlug to display information about the product. These fields are not directly tied to the product reference and remain available for display, even if the product itself is missing. Note that these properties are eventually consistent and may not always reflect the latest product state.
productId ID!: The unique identifier of the product associated with the order line item.
productName String!: The name of the product associated with the order line item.
productSlug String!: The slug of the product associated with the order line item, useful for generating URLs or displaying product information.
quantity Int!: Retrieves the quantity of the order line item.
sku String!: The SKU (Stock Keeping Unit) of the variant associated with the order line item, often used for inventory management.
subtotal Money!: The line items total excluding discounts and taxes.
taxBehavior TaxBehavior!: Gets the tax behavior of the order line item, which indicates how taxes are applied to the item.
Possible enum values
EXCLUSIVE
Exclusive tax is added on top of the price. For example, a product has the price defined as 5.00 USD. The tax charged on this product could be 10% and would result in a final price of 5.50 USD. (Tax rates might differ—this is only an explanatory example.)
INCLUSIVE
Inclusive tax is already included in the price. For example, a product has the price defined as 5.00 USD. The final price the customer pays is 5.00 USD.
taxRate TaxRate: Retrieves the tax rate applied to the order line item. This may be null if the line item does not have a tax rate defined.
taxedPrice TaxedPrice: Gets the taxed price of the LineItem. This may be null if the LineItem does not yet have a taxed price.
total Money!: The total amount for the order line item, including taxes and discounts.
type LineItemType!: Indicates whether the line item is managed by the catalog or supplied as a custom item.
Possible enum values
CUSTOM
The line item was entered independently of a catalog product variant.
MANAGED
The line item references a product variant managed in the catalog.
unitPrice UnitPrice!: Retrieves the unit price of the order line item.
variant ProductVariant: This retrieves the variant associated with a cart line item. If the variant no longer exists—such as if it has been removed from the channel or deleted entirely—this will return null. In such cases, you can still use other properties like variantName and variantSku to display information about the variant. These fields are not directly tied to the variant reference and remain available for display, even if the variant itself is missing. Note that these properties are eventually consistent and may not always reflect the latest variant state.
variantId ID!: The unique identifier of the variant associated with the order line item.
variantName String!: The name of the variant associated with the order line item.