variant

A product variant.

Properties

available boolean: Returns true if the variant is available. Returns false if not.
barcode string: The barcode of the variant.
compare_at_price number: The compare at price of the variant in the currency's subunit.

The value is output in the customer's local (presentment) currency.

For currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.

Tip
Use money filters to output a formatted price.
Tip: Use <a href="/docs/api/liquid/filters/money-filters">money filters</a> to output a formatted price.
featured_image image: The image attached to the variant.

Note
This is the same value as variant.image.
Note: This is the same value as <a href="/docs/api/liquid/objects/variant#variant-image"><code>variant.image</code></a>.
featured_media media: The first media object attached to the variant.
id number: The ID of the variant.
image image: The image attached to the variant.

Note
This is the same value as variant.featured_image.
Note: This is the same value as <a href="/docs/api/liquid/objects/variant#variant-featured_image"><code>variant.featured_image</code></a>.
incoming boolean: Returns true if the variant has incoming inventory. Returns false if not.

Incoming inventory information is populated by inventory transfers, purchase orders, and third-party apps.
inventory_management string: The inventory management service of the variant.

If inventory isn't tracked, then nil is returned.
inventory_policy string from a set of values: Whether the variant should continue to be sold when it's out of stock.

Tip
To learn about why merchants might want to continue selling products when they're out of stock, visit the Shopify Help Center.
Tip: To learn about why merchants might want to continue selling products when they're out of stock, visit the <a href="https://help.shopify.com/manual/products/inventory/getting-started-with-inventory/selling-when-out-of-stock">Shopify Help Center</a>.
Possible values Description
continue Continue selling when the variant is out of stock.
deny Stop selling when the variant is out of stock.
inventory_quantity number: The inventory quantity of the variant.

If inventory isn't tracked, then the number of items sold is returned.
matched boolean: Returns true if the variant has been matched by a storefront filter or no filters are applied. Returns false if it hasn't.
metafields: The metafields applied to the variant.

Tip
To learn about how to create metafields, refer to Create and manage metafields or visit the Shopify Help Center.
Tip: To learn about how to create metafields, refer to <a href="/apps/metafields/manage">Create and manage metafields</a> or visit the <a href="https://help.shopify.com/manual/metafields">Shopify Help Center</a>.
next_incoming_date string: The arrival date for the next incoming inventory of the variant.

Incoming inventory information is populated by inventory transfers, purchase orders, and third-party apps.

Tip
Use the date filter to format the date.
Tip: Use the <a href="/docs/api/liquid/filters/date"><code>date</code> filter</a> to format the date.
options product_option_value: The values of the variant for each product option.

Example
Output the options of each variant
{% for variant in product.variants -%}
{%- capture options -%}
{% for option in variant.options -%}
{{ option }}{%- unless forloop.last -%}/{%- endunless -%}
{%- endfor %}
{%- endcapture -%}

{{ variant.id }}: {{ options }}
{%- endfor %}
Code
{% for variant in product.variants -%} {%- capture options -%} {% for option in variant.options -%} {{ option }}{%- unless forloop.last -%}/{%- endunless -%} {%- endfor %} {%- endcapture -%} {{ variant.id }}: {{ options }} {%- endfor %}
Data
{ "product": { "variants": [ { "id": 39897499729985, "options": [ "S", "Low" ] }, { "id": 39897499762753, "options": [ "S", "Medium" ] }, { "id": 39897499795521, "options": [ "S", "High" ] }, { "id": 39897499828289, "options": [ "M", "Low" ] }, { "id": 39897499861057, "options": [ "M", "Medium" ] }, { "id": 39897499893825, "options": [ "M", "High" ] }, { "id": 39897499926593, "options": [ "L", "Low" ] }, { "id": 39897499959361, "options": [ "L", "Medium" ] }, { "id": 39897499992129, "options": [ "L", "High" ] } ] } }
Output
39897499729985: S/Low

39897499762753: S/Medium

39897499795521: S/High

39897499828289: M/Low

39897499861057: M/Medium

39897499893825: M/High

39897499926593: L/Low

39897499959361: L/Medium

39897499992129: L/High
Output
39897499729985: S/Low 39897499762753: S/Medium 39897499795521: S/High 39897499828289: M/Low 39897499861057: M/Medium 39897499893825: M/High 39897499926593: L/Low 39897499959361: L/Medium 39897499992129: L/High
price number: The price of the variant in the currency's subunit.

The value is output in the customer's local (presentment) currency.

For currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.

Tip
Use money filters to output a formatted price.
Tip: Use <a href="/docs/api/liquid/filters/money-filters">money filters</a> to output a formatted price.
product product: The parent product of the variant.
quantity_price_breaks array of quantity_price_break: Returns quantity_price_break objects for the variant in the current customer context.
quantity_price_breaks_configured? boolean: Returns true if the variant has any quantity price breaks available in the current customer context. Returns false if it doesn't.
quantity_rule quantity_rule: The quantity rule for the variant.

If no rule exists, then a default value is returned.

This rule can be set as part of a B2B catalog.

Note
The default quantity rule is min=1,max=null,increment=1.
Note: The default quantity rule is <code>min=1,max=null,increment=1</code>.
requires_selling_plan boolean: Returns true if the variant's product is set to require a selling_plan when being added to the cart. Returns false if not.
requires_shipping boolean: Returns true if the variant requires shipping. Returns false if it doesn't.
selected boolean: Returns true if the variant is currently selected. Returns false if it's not.

Note
The selected variant is determined by the variant URL parameter. This URL parameter is available on product pages URLs only.
Note: The selected variant is determined by the <code>variant</code> URL parameter. This URL parameter is available on product pages URLs only.
selected_selling_plan_allocation selling_plan_allocation: The selected selling_plan_allocation.

If no selling plan is selected, then nil is returned.

Note
The selected selling plan is determined by the selling_plan URL parameter.
Note: The selected selling plan is determined by the <code>selling_plan</code> URL parameter.
selling_plan_allocations array of selling_plan_allocation: The selling_plan_allocation objects for the variant.
sku string: The SKU of the variant.
store_availabilities array of store_availability: The store availabilities for the variant.

The array is defined in only the following cases:

variant.selected is true

The variant is the product's first available variant. For example, product.first_available_variant or product.selected_or_first_available_variant.
taxable boolean: Returns true if taxes should be charged on the variant. Returns false if not.
title string: A concatenation of each variant option, separated by a /.

Example
The variant title
{{ product.variants.first.title }}
Code
{{ product.variants.first.title }}
Data
{ "product": { "variants": [ { "title": "S / Low" }, { "title": "S / Medium" }, { "title": "S / High" }, { "title": "M / Low" }, { "title": "M / Medium" }, { "title": "M / High" }, { "title": "L / Low" }, { "title": "L / Medium" }, { "title": "L / High" } ] } }
Output
S / Low
Output
S / Low
unit_price number: The unit price of the variant in the currency's subunit.

The price reflects any discounts that are applied to the line item. The value is output in the customer's local (presentment) currency.

For currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.

Tip
Use the unit_price_with_measurement filter with this property and the variant.unit_price_measurement property to output a formatted unit price with measurement.
Tip: Use the <a href="/docs/api/liquid/filters/unit_price_with_measurement"><code>unit_price_with_measurement</code> filter</a> with this property and the <code>variant.unit_price_measurement</code> property to output a formatted unit price with measurement.
To learn about how to display unit prices in your theme, refer to Unit pricing.
unit_price_measurement unit_price_measurement: The unit price measurement of the variant.

To learn about how to display unit prices in your theme, refer to Unit pricing.

Tip
Use the unit_price_with_measurement filter with the variant.unit_price property and this property to output a formatted unit price with measurement.
Tip: Use the <a href="/docs/api/liquid/filters/unit_price_with_measurement"><code>unit_price_with_measurement</code> filter</a> with the <code>variant.unit_price</code> property and this property to output a formatted unit price with measurement.
url string: The URL of the variant.

Variant URLs use the following structure:

/products/[product-handle]?variant=[variant-id]
weight number: The weight of the variant in grams.

Tip
Use the weight_with_unit filter to format the weight in the store's format.

Use variant.weight_in_unit to output the weight in the unit configured on the variant.
Tip: Use the <a href="/docs/api/liquid/filters/weight_with_unit"><code>weight_with_unit</code></a> filter to format the weight in <a href="https://www.shopify.com/admin/settings/general">the store's format</a>. Use <code>variant.weight_in_unit</code> to output the weight in the unit configured on the variant.
weight_in_unit number: The weight of the variant in the unit specified by variant.weight_unit.

Tip
To output this weight, use this property, and the variant.weight_unit property, with the weight_with_unit filter.
Tip: To output this weight, use this property, and the <code>variant.weight_unit</code> property, with the <a href="/docs/api/liquid/filters/weight_with_unit"><code>weight_with_unit</code> filter</a>.
weight_unit string: The unit for the weight of the variant.

Tip
To output the weight of a variant in this unit, use this property, and the variant.weight_in_unit property, with the weight_with_unit filter.
Tip: To output the weight of a variant in this unit, use this property, and the <code>variant.weight_in_unit</code> property, with the <a href="/docs/api/liquid/filters/weight_with_unit"><code>weight_with_unit</code> filter</a>.

Possible values	Description
continue	Continue selling when the variant is out of stock.
deny	Stop selling when the variant is out of stock.

Deprecated Properties

option1 string Deprecated: The value of the variant for the first product option.

If there's no first product option, then nil is returned.

Deprecated
Deprecated. Prefer to use variant.options instead.
option2 string Deprecated: The value of the variant for the second product option.

If there's no second product option, then nil is returned.

Deprecated
Deprecated. Prefer to use variant.options instead.
option3 string Deprecated: The value of the variant for the third product option.

If there's no third product option, then nil is returned.

Deprecated
Deprecated. Prefer to use variant.options instead.

{

"available": true,

"barcode": "",

"compare_at_price": null,

"featured_image": null,

"featured_media": null,

"id": 39897499729985,

"image": null,

"incoming": false,

"inventory_management": "shopify",

"inventory_policy": "deny",

"inventory_quantity": 5,

"matched": true,

"metafields": {},

"next_incoming_date": null,

"option1": "S",

"option2": "Low",

"option3": null,

"options": [],

"price": "10.00",

"product": {},

"quantity_price_breaks": [],

"quantity_rule": {},

"requires_selling_plan": false,

"requires_shipping": true,

"selected": false,

"selected_selling_plan_allocation": null,

"selling_plan_allocations": [],

"sku": "",

"store_availabilities": [],

"taxable": true,

"title": "S / Low",

"unit_price": null,

"unit_price_measurement": null,

"url": {},

"weight": 500,

"weight_in_unit": 500,

"weight_unit": "g"

}

Example

{
  "available": true,
  "barcode": "",
  "compare_at_price": null,
  "featured_image": null,
  "featured_media": null,
  "id": 39897499729985,
  "image": null,
  "incoming": false,
  "inventory_management": "shopify",
  "inventory_policy": "deny",
  "inventory_quantity": 5,
  "matched": true,
  "metafields": {},
  "next_incoming_date": null,
  "option1": "S",
  "option2": "Low",
  "option3": null,
  "options": [],
  "price": "10.00",
  "product": {},
  "quantity_price_breaks": [],
  "quantity_rule": {},
  "requires_selling_plan": false,
  "requires_shipping": true,
  "selected": false,
  "selected_selling_plan_allocation": null,
  "selling_plan_allocations": [],
  "sku": "",
  "store_availabilities": [],
  "taxable": true,
  "title": "S / Low",
  "unit_price": null,
  "unit_price_measurement": null,
  "url": {},
  "weight": 500,
  "weight_in_unit": 500,
  "weight_unit": "g"
}

Was this section helpful?

Properties

Code

Data

Output

Output

Code

Data

Output

Output

Deprecated Properties

Example