Line Item
A single line item in an order.
Anchor to FieldsFields
- Anchor to currentTotalPricecurrent•Money
Total Price V2Pre-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.
- Anchor to customAttributescustom•[Attribute!]!non-nullPre-auth accessible
Attributes The list of custom attributes associated with the line item.
- Anchor to discountAllocationsdiscount•[Discount
Allocations Allocation!]!non-nullPre-auth accessible The discounts that have been allocated onto the line item by discount applications.
- Anchor to giftCardgift•Boolean!non-nullPre-auth accessible
Card Whether the line item represents the purchase of a gift card.
- Anchor to groupgroup•Line
Item GroupPre-auth accessible The line item group associated to the line item.
- •ID!non-nullPre-auth accessible
A globally-unique ID.
- Anchor to imageimage•ImagePre-auth accessible
The image object associated with the line item.
- Anchor to namename•String!non-nullPre-auth accessible
The name of the product.
- Anchor to presentmentTitlepresentment•StringPre-auth accessible
Title The title of the line item variant.
- Anchor to priceprice•Money
V2Pre-auth accessible The product variant price without any discounts applied, in presentment currencies.
- Anchor to productIdproduct•IDPre-auth accessible
Id The product's ID.
- Anchor to productTypeproduct•StringPre-auth accessible
Type The product's type.
- Anchor to quantityquantity•Int!non-nullPre-auth accessible
The number of variant items ordered.
- Anchor to refundableQuantityrefundable•Int!non-nullPre-auth accessible
Quantity The quantity of the line item, minus the refunded quantity.
- Anchor to requiresShippingrequires•Boolean!non-nullPre-auth accessible
Shipping Whether physical shipping is required for the variant.
- •StringPre-auth accessible
The SKU number of the variant.
- Anchor to titletitle•String!non-nullPre-auth accessible
The title of the product or variant. This field only applies to custom line items.
- Anchor to totalDiscounttotal•Money
Discount V2!non-nullPre-auth accessible The total of the discount allocations on this line item, resulting from discounts applied specifically to this line item.
- Anchor to totalPricetotal•Money
Price V2Pre-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.
- Anchor to unitPriceunit•Unit
Price PricePre-auth accessible The unit price of the line item in presentment currencies.
- Anchor to variantIdvariant•IDPre-auth accessible
Id The ID of the variant.
- Anchor to variantOptionsvariant•[Line
Options Item Variant Option!]Pre-auth accessible The options of the product variant.
- Anchor to variantTitlevariant•StringPre-auth accessible
Title The name of the variant.
- Anchor to vendorvendor•StringPre-auth accessible
The product's vendor.