Skip to main content
object

A single line item in an order.

•MoneyV2Pre-auth accessible

The total price of the line item, calculated by multiplying the current unit price of the variant by the quantity, expressed in presentment currencies.

•[Attribute!]!non-nullPre-auth accessible

The list of custom attributes associated with the line item.

•[DiscountAllocation!]!non-nullPre-auth accessible

The discounts that have been allocated onto the line item by discount applications.

•Boolean!non-nullPre-auth accessible

Whether the line item represents the purchase of a gift card.

•LineItemGroupPre-auth accessible

The line item group associated to the line item.

•ID!non-nullPre-auth accessible

A globally-unique ID.

•ImagePre-auth accessible

The image object associated with the line item.

•String!non-nullPre-auth accessible

The name of the product.

•StringPre-auth accessible

The title of the line item variant.

•MoneyV2Pre-auth accessible

The product variant price without any discounts applied, in presentment currencies.

•IDPre-auth accessible

The product's ID.

•StringPre-auth accessible

The product's type.

•Int!non-nullPre-auth accessible

The number of variant items ordered.

•Int!non-nullPre-auth accessible

The quantity of the line item, minus the refunded quantity.

•Boolean!non-nullPre-auth accessible

Whether physical shipping is required for the variant.

•StringPre-auth accessible

The SKU number of the variant.

•String!non-nullPre-auth accessible

The title of the product or variant. This field only applies to custom line items.

•MoneyV2!non-nullPre-auth accessible

The total of the discount allocations on this line item, resulting from discounts applied specifically to this line item.

•MoneyV2Pre-auth accessible

The total price of the line item, calculated by multiplying the current unit price of the variant by the quantity, expressed in presentment currencies.

•UnitPricePre-auth accessible

The unit price of the line item in presentment currencies.

•IDPre-auth accessible

The ID of the variant.

•[LineItemVariantOption!]Pre-auth accessible

The options of the product variant.

•StringPre-auth accessible

The name of the variant.

•StringPre-auth accessible

The product's vendor.


Was this section helpful?

•interface

Was this section helpful?