The line_item object

A line_item represents a single line in the shopping cart. There is one line item for each distinct product variant in the cart. The line_item object can be accessed in all Liquid templates via cart.items, in notification email templates via line_items, on the order status page of the checkout, as well as in apps such as Order Printer.

The line_item object has the following attributes:

line_item.discount_allocations

Returns a list of all discount allocations containing the discounted amount and the reference to the parent discount application. line_item.discount_allocations is available on line items in carts, checkouts, orders, and draft orders.

line_item.final_line_price

Returns the combined price of all the items in the line item. This is equal to line_item.final_price times line_item.quantity.

line_item.final_price

Returns the price of the line item including all line level discount amounts.

line_item.fulfillment

Returns the fulfillment of the line item.

line_item.fulfillment_service

Returns the fulfillment service associated with the line item's variant. Line items that have no fulfillment service will return manual.

line_item.gift_card

Returns true if the line item's product is a gift card, or false if it is not.

line_item.grams

Returns the weight of the line item.

Use the weight_with_unit filter to format the weight.

line_item.id

Returns the line item ID.

The line item ID differs depending on the context:

  • cart.items returns the ID of the line item's variant. This ID is not unique, and can be shared by multiple items of the same variant.
  • checkout.line_items returns a temporary unique hash generated for the checkout.
  • order.line_items returns a unique integer ID.

line_item.image

Returns the line item's image.

You can apply the img_url filter directly to the line item instead of its image attribute. This will generate a working image URL for any object with an image attribute (variant, product, line item, collection), image object, or image src. This is useful for line items, since it will output the item's variant image or the product's featured image if no variant image exists.

In the example, note that the output is the same no matter if img_url is used on line_item or line_item.image.

line_item.key

Returns the line item key, a unique identifier for the line item. The line item key is constructed from the ID of the line item's variant, and a hash of the line item's properties, even if the item has no additional properties.

line_item.line_level_discount_allocations

Returns a list of line-specific discount allocations containing the discounted amount and the reference to the parent discount application. line_item.discount_allocations is available on line items in carts, checkouts, orders, and draft orders.

line_item.line_level_total_discount

Returns the total amount of all discounts applied to the line item specifically. This doesn't include discounts that are added to the cart.

line_item.message

Returns the discount message if a script has applied a discount to the line item.

This attribute only has a value if you are using the Script Editor app.

line_item.options_with_values

Returns an array of selected values from the item's product options.

Elements in line_item.options_with_values can be displayed using a for loop. Each option is a key-value pair with option.name as the option and option.value as the option value.