Liquid Template Variables - line item - Revision history

Admin: /* line_item.back_ordered */

2021-06-18T03:55:11Z

line_item.back_ordered

Admin: /* line_item.taxable */

2021-06-18T03:54:13Z

line_item.taxable

Admin: /* line_item.title */

2018-08-22T01:55:40Z

line_item.title

Admin: /* line_item.cart_index */

2018-08-22T01:49:29Z

line_item.cart_index

Admin: /* line_item.id */

2018-08-22T01:48:42Z

line_item.id

Admin: /* line_item.product */

2016-01-29T01:06:40Z

line_item.product

Admin: /* line_item.variant */

2016-01-29T01:06:04Z

line_item.variant

Admin: /* line_item.taxable */

2016-01-29T01:05:10Z

line_item.taxable

Admin: /* line_item.properties */

2015-08-27T06:07:12Z

line_item.properties

Admin: /* line_item.properties */

2015-08-27T06:06:58Z

line_item.properties

@@ Line 123: / Line 123: @@
 == <code>line_item.back_ordered</code> ==
 Returns <code>true</code> if the line item was out of stock or partially out of stock at the time the order was placed. This flag will only be set if the item is configured to support inventory management and the setting allows the purchase of items even if they are out of stock.
 == <code>line_item.url</code> ==

@@ Line 120: / Line 120: @@
 == <code>line_item.taxable</code> ==
 Returns <code>true</code> if the line item is taxable and <code>false</code> if the line item is tax free.
 == <code>line_item.url</code> ==

← Older revision		Revision as of 01:55, 22 August 2018
Line 44:		Line 44:

	This is equal to the original product's title, for example, ''"Balloon Shirt"''. If the product has more than one variant, then the name of the variant will be appended to the title. So if the ''"Balloon Shirt"'' has two variants, ''"Medium"'' and ''"Large"'', then '''line_item.title''' will be ''"Balloon Shirt - Medium"'' or ''"Balloon Shirt - Large"''. If a ''"Yellow Flower Baseball Cap"'' product only has one variant called ''"Default"'' then its line_item.title would just be'' "Yellow Flower Baseball Cap"''.		This is equal to the original product's title, for example, ''"Balloon Shirt"''. If the product has more than one variant, then the name of the variant will be appended to the title. So if the ''"Balloon Shirt"'' has two variants, ''"Medium"'' and ''"Large"'', then '''line_item.title''' will be ''"Balloon Shirt - Medium"'' or ''"Balloon Shirt - Large"''. If a ''"Yellow Flower Baseball Cap"'' product only has one variant called ''"Default"'' then its line_item.title would just be'' "Yellow Flower Baseball Cap"''.
		+
		+	== <code>line_item.extended_title</code> ==
		+
		+	Returns the title of this line item, without any additional variant option descriptions.
		+
		+	The additional variant option descriptions are available in ''line_item.extended_options''.
		+
		+	== <code>line_item.extended_options</code> ==
		+
		+	Returns a hash of all variant option descriptions.
		+
		+	<pre>
		+	<ul>
		+	{% for option in line_item.extended_options %}
		+	<li>{{ option.first }}: {{ option.last }}</li>
		+	{% endfor %}
		+	</ul>
		+	</pre>

	== <code>line_item.price</code> ==		== <code>line_item.price</code> ==

← Older revision		Revision as of 01:49, 22 August 2018
Line 22:		Line 22:

	Returns a unique cart index number for the line item. This index number allows you to refer to a specific line item in the cart, even when there are other line items for the same variation.		Returns a unique cart index number for the line item. This index number allows you to refer to a specific line item in the cart, even when there are other line items for the same variation.
		+
		+	This is only available for ''cart'' line items.

	This variable is used in the <code>cart.liquid</code> template instead of <code>line_item.variant.id</code> that was previously used. The change is necessary as the cart now supports unique line items so that items with custom notes attached are added as unique line items. Obviously they all have the same value for <code>line_item.variant.id</code>, so this new index is used instead.		This variable is used in the <code>cart.liquid</code> template instead of <code>line_item.variant.id</code> that was previously used. The change is necessary as the cart now supports unique line items so that items with custom notes attached are added as unique line items. Obviously they all have the same value for <code>line_item.variant.id</code>, so this new index is used instead.

@@ Line 17: / Line 17: @@
 Returns the unique internal id of the line item.
-This is normally only for internal usage.
+This is normally only for internal usage and is only available for ''order'' line items.
 == <code>line_item.cart_index</code> ==

@@ Line 31: / Line 31: @@
 == <code>line_item.product</code> ==
-Returns the product for this line_item.
+Returns the [[Liquid Template Variables - product|product]] for this line_item.
 For example, this code retrieves a line item's image:

@@ Line 27: / Line 27: @@
 == <code>line_item.variant</code> ==
-Returns the product variant for this line item.
+Returns the product [[Liquid Template Variables - variant|variant]] for this line item.
 == <code>line_item.product</code> ==

← Older revision		Revision as of 01:05, 29 January 2016
Line 102:		Line 102:

	Returns <code>true</code> if the line item is taxable and <code>false</code> if the line item is tax free.		Returns <code>true</code> if the line item is taxable and <code>false</code> if the line item is tax free.
		+
		+	== <code>line_item.url</code> ==
		+
		+	Return the product page URL associated with this line item, including the ''variant'' parameter to enable direct linking to the selected variant.
		+
		+	<pre>
		+	{{ line_item.title \| link_to: line_item.url }} =>
		+
		+	<a href="/products/cute-dog?variant=9876543">Cute Dog - Brown</a>
		+	</pre>
		+
		+	== <code>line_item.image</code> ==
		+
		+	Return the [[Liquid Template Variables - image\|image]] associated with the line item.
		+
		+	As a short-cut, we can apply the '''img_url''' filter directly to the line item, rather than using the '''line_item.image''' attribute.
		+
		+	<pre>
		+	{{ line_item.image \| img_url: 'small' \| img_tag }}
		+
		+	produces the same result as
		+
		+	{{ line_item \| img_url: 'small' \| img_tag }}
		+	</pre>

@@ Line 73: / Line 73: @@
 For example, you might have the following fields defined for your product:
 <pre>
-Card Message: Thank you for all your help to setup my Spiffy Store.
+Card Message: Thank you for all your help to set up my Spiffy Store.
 Gift Wrapping: Yes
 </pre>