variant

Properties

Anchor to

available

boolean

Returns true if the variant is available. Returns false if not.

Anchor to

barcode

string

The barcode of the variant.

Anchor to

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.

Anchor to

featured_image

image

The image attached to the variant.

Note

This is the same value as variant.image.

Anchor to

featured_media

media

The first media object attached to the variant.

Anchor to

id

number

The ID of the variant.

Anchor to

image

image

The image attached to the variant.

Note

This is the same value as variant.featured_image.

Anchor to

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.

Anchor to

inventory_management

string

The inventory management service of the variant.

If inventory isn't tracked, then nil is returned.

Anchor to

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.

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

Anchor to

inventory_quantity

number

The inventory quantity of the variant.

If inventory isn't tracked, then the number of items sold is returned.

Anchor to

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.

Anchor to

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.

Anchor to

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.

Anchor to

options

product_option_value

The values of the variant for each product option.

Example

Output the options of each variant

CodeData

Reset Code

9

1

2

3

4

5

6

7

8

9

{% 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

99

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

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

Anchor to

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.

Anchor to

product

product

The parent product of the variant.

Anchor to

quantity_price_breaks

array of quantity_price_break

Returns quantity_price_break objects for the variant in the current customer context.

Anchor to

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.

Anchor to

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.

Anchor to

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.

Anchor to

requires_shipping

boolean

Returns true if the variant requires shipping. Returns false if it doesn't.

Anchor to

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.

Anchor to

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.

Anchor to

selling_plan_allocations

array of selling_plan_allocation

The selling_plan_allocation objects for the variant.

Anchor to

sku

string

The SKU of the variant.

Anchor to

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.

Anchor to

taxable

boolean

Returns true if taxes should be charged on the variant. Returns false if not.

Anchor to

title

string

A concatenation of each variant option, separated by a /.

Example

The variant title

CodeData

Reset Code

9

1

{{ 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

9

1

S / Low

Anchor to

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.

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

Anchor to

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.

Anchor to

url

string

The URL of the variant.

Variant URLs use the following structure:

/products/[product-handle]?variant=[variant-id]

Anchor to

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.

Anchor to

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.

Anchor to

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.