- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
LineItem - Cart Module Data Models Reference
This documentation provides a reference to the LineItem data model. It belongs to the Cart Module.
id
PrimaryKeyModifier<IdProperty>The ID of the line item.
title
TextPropertyThe title of the line item
quantity
NumberPropertyThe quantity of the line item
requires_shipping
BooleanPropertyWhether the line item requires shipping.
is_discountable
BooleanPropertyWhether the line item is discountable.
is_tax_inclusive
BooleanPropertyWhether the line item's price is tax inclusive.
unit_price
BigNumberPropertyThe unit price of the line item
The associated adjustments.
The associated tax_lines.
The associated cart.
subtitle
TextPropertyOptionalThe subtitle of the line item
thumbnail
TextPropertyOptionalThe thumbnail URL of the line item
variant_id
TextPropertyOptionalThe ID of the variant added to the cart.
product_id
TextPropertyOptionalThe ID of the product added to the cart.
product_title
TextPropertyOptionalThe title of the line item's product
product_description
TextPropertyOptionalThe description of the line item's product
product_subtitle
TextPropertyOptionalThe subtitle of the line item's product
product_type
TextPropertyOptionalThe type of the line item's product
product_type_id
TextPropertyOptionalThe ID of the type of the line item's product
product_collection
TextPropertyOptionalThe collection of the line item's product
product_handle
TextPropertyOptionalThe unique handle of the line item's product
variant_sku
TextPropertyOptionalThe SKU of the line item's variant
variant_barcode
TextPropertyOptionalThe barcode of the line item's variant
variant_title
TextPropertyOptionalThe title of the line item's variant
variant_option_values
JSONPropertyOptionalThe values of the line item variant's options.
compare_at_unit_price
BigNumberPropertyOptionalThe original price of the item before a promotion or sale.
metadata
JSONPropertyOptionalHolds custom data in key-value pairs.
Was this page helpful?