LineItem - Cart Module Data Models Reference

This documentation provides a reference to the LineItem data model. It belongs to the Cart Module.

idPrimaryKeyModifier<IdProperty>
The ID of the line item.
titleTextProperty
The title of the line item
quantityNumberProperty
The quantity of the line item
requires_shippingBooleanProperty
Whether the line item requires shipping.
is_discountableBooleanProperty
Whether the line item is discountable.
is_tax_inclusiveBooleanProperty
Whether the line item's price is tax inclusive.
unit_priceBigNumberProperty
The unit price of the line item
adjustmentsHasMany<LineItemAdjustment>
The associated adjustments.
tax_linesHasMany<LineItemTaxLine>
The associated tax_lines.
cartBelongsTo<Cart>
The associated cart.
subtitleTextPropertyOptional
The subtitle of the line item
thumbnailTextPropertyOptional
The thumbnail URL of the line item
variant_idTextPropertyOptional
The ID of the variant added to the cart.
product_idTextPropertyOptional
The ID of the product added to the cart.
product_titleTextPropertyOptional
The title of the line item's product
product_descriptionTextPropertyOptional
The description of the line item's product
product_subtitleTextPropertyOptional
The subtitle of the line item's product
product_typeTextPropertyOptional
The type of the line item's product
product_type_idTextPropertyOptional
The ID of the type of the line item's product
product_collectionTextPropertyOptional
The collection of the line item's product
product_handleTextPropertyOptional
The unique handle of the line item's product
variant_skuTextPropertyOptional
The SKU of the line item's variant
variant_barcodeTextPropertyOptional
The barcode of the line item's variant
variant_titleTextPropertyOptional
The title of the line item's variant
variant_option_valuesJSONPropertyOptional
The values of the line item variant's options.
compare_at_unit_priceBigNumberPropertyOptional
The original price of the item before a promotion or sale.
metadataJSONPropertyOptional
Holds custom data in key-value pairs.
Was this page helpful?