CreateCartCreateLineItemDTO

The details of the line item to create.

Properties#

The quantity of the line item.
variant_idstringOptional
The ID of the variant to be added to the cart.
titlestringOptional
The title of the line item.
subtitlestringOptional
The subtitle of the line item.
thumbnailstringOptional
The thumbnail URL of the line item.
product_idstringOptional
The ID of the product whose variant is being added to the cart.
product_titlestringOptional
The title of the associated product.
product_descriptionstringOptional
The description of the associated product.
product_subtitlestringOptional
The subtitle of the associated product.
product_typestringOptional
The ID of the associated product's type.
product_collectionstringOptional
The ID of the associated product's collection.
product_handlestringOptional
The handle of the associated product.
variant_skustringOptional
The SKU of the associated variant.
variant_barcodestringOptional
The barcode of the associated variant.
variant_titlestringOptional
The title of the associated variant.
variant_option_valuesRecord<string, unknown>Optional
The associated variant's values for the product's options.
requires_shippingbooleanOptional
Whether the line item requires shipping.
is_discountablebooleanOptional
Whether the line item is discountable.
is_tax_inclusivebooleanOptional
Whether the line item's price is tax inclusive. Learn more in this documentation
is_giftcardbooleanOptional
Whether the line item is a gift card.
compare_at_unit_priceBigNumberInputOptional
The original price of the item before a promotion or sale.
unit_priceBigNumberInputOptional
The price of a single quantity of the item.
metadatanull | Record<string, unknown>Optional
Custom key-value pairs related to the item.
Was this page helpful?
Edit this page