BaseCartLineItem
The cart line item details.
Properties#
idstringThe ID of the line item.
titlestringThe title of the line item.
quantitynumberThe line item's quantity in the cart.
requires_shippingbooleanWhether the line item requires shipping.
is_discountablebooleanWhether the line item is discountable.
is_tax_inclusivebooleanWhether the line item price is tax inclusive.
unit_pricenumberThe unit price of the item.
The associated cart.
cart_idstringThe ID of the associated cart.
original_totalnumberThe original total of the cart line item.
original_subtotalnumberThe original subtotal of the cart line item.
original_tax_totalnumberThe original tax total of the cart line item.
item_totalnumberThe item total of the cart line item.
item_subtotalnumberThe item subtotal of the cart line item.
item_tax_totalnumberThe item tax total of the cart line item.
totalnumberThe total of the cart line item.
subtotalnumberThe subtotal of the cart line item.
tax_totalnumberThe tax total of the cart line item.
discount_totalnumberThe discount total of the cart line item.
discount_tax_totalnumberThe discount tax total of the cart line item.
subtitlestringOptionalThe subtitle of the line item.
thumbnailstringOptionalThe line item's thumbnail.
The associated product with the line item.
product_idstringOptionalThe ID of the associated product.
product_titlestringOptionalThe title of the associated product.
product_descriptionstringOptionalThe description of the associated product.
product_subtitlestringOptionalThe subtitle of the associated product.
product_typestringOptionalThe type of the associated product.
product_collectionstringOptionalThe collection of the associated product.
product_handlestringOptionalThe handle of the associated product.
The associated variant with the line item.
variant_idstringOptionalThe associated variant's ID of the line item.
variant_skustringOptionalThe sku of the associated variant.
variant_barcodestringOptionalThe barcode of the associated variant.
variant_titlestringOptionalThe title of the associated variant.
variant_option_valuesRecord<string, unknown>OptionalThe option values of the associated variant.
compare_at_unit_pricenumberOptionalThe calculated price of the line item.
The associated tax lines.
The associated adjustments.
metadatanull | Record<string, unknown>OptionalHolds custom data in key-value pairs.
created_atDateOptionalWhen the line item was created.
updated_atDateOptionalWhen the line item was updated.
deleted_atDateOptionalWhen the line item was deleted.
Was this page helpful?