remote_product

Properties

Anchor to

available

boolean

Returns true if at least one of the variants of the product is available. Returns false if not.

For a variant to be available, it needs to meet one of the following criteria:

• The variant.inventory_quantity is greater than 0.
• The variant.inventory_policy is set to continue.
• The variant.inventory_management is nil.
• The variant has an associated delivery profile with a valid shipping rate.

Anchor to

category

taxonomy_category

The taxonomy category for the product

Anchor to

compare_at_price

number

The lowest compare at price of any variants of the product 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.

Anchor to

compare_at_price_max

number

The highest compare at price of any variants of the product 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.

Anchor to

compare_at_price_min

number

The lowest compare at price of any variants of the product in the currency's subunit. This is the same as product.compare_at_price.

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.

Anchor to

compare_at_price_varies

boolean

Returns true if the variant compare at prices of the product vary. Returns false if not.

Anchor to

content

string

The description of the product.

Note

This is the same value as product.description.

Note: This is the same value as <a href="/docs/api/liquid/objects/product#product-description"><code>product.description</code></a>.

Anchor to

created_at

string

A timestamp for when the product was created.

Tip

Use the date filter to format the timestamp.

Tip: Use the <a href="/docs/api/liquid/filters/date"><code>date</code> filter</a> to format the timestamp.

Anchor to

description

string

The description of the product.

Note

This is the same value as product.content. The description of remote products is modified to include a link to the remote store's shipping and refund policies, if the shop has defined them.

Note: This is the same value as <a href="/docs/api/liquid/objects/product#product-content"><code>product.content</code></a>. The description of remote products is modified to include a link to the remote store&#39;s shipping and refund policies, if the shop has defined them.

Anchor to

featured_image

image

The first (featured) image attached to the product.

Anchor to

featured_media

media

The first (featured) media attached to the product.

Note

Depending on rendering context, the featured media of remote products may be modified to include a badge highlighting the remote source.

Note: Depending on rendering context, the featured media of remote products may be modified to include a badge highlighting the remote source.

Tip

You can use media filters to output media URLs and displays. To learn about how to include media in your theme, refer to Support product media.

Tip: You can use <a href="/docs/api/liquid/filters/media-filters">media filters</a> to output media URLs and displays. To learn about how to include media in your theme, refer to <a href="/themes/product-merchandising/media/support-media">Support product media</a>.

Anchor to

first_available_variant

variant

The first available variant of the product.

For a variant to be available, it needs to meet one of the following criteria:

• The variant.inventory_quantity is greater than 0.
• The variant.inventory_policy is set to continue.
• The variant.inventory_management is nil.

Anchor to

gift_card?

boolean

Returns true if the product is a gift card. Returns false if not.

Anchor to

has_only_default_variant

boolean

Returns true if the product doesn't have any options. Returns false if not.

Anchor to

id

number

The ID of the product.

Anchor to

images

array of image

The images attached to the product.

Anchor to

media

array of media

The media attached to the product, sorted by the date it was added to the product.

Note

Depending on rendering context, the media of remote products may be modified to include a badge highlighting the remote source.

Note: Depending on rendering context, the media of remote products may be modified to include a badge highlighting the remote source.

Tip

You can use media filters to output media URLs and displays. To learn about how to include media in your theme, refer to Support product media.

Tip: You can use <a href="/docs/api/liquid/filters/media-filters">media filters</a> to output media URLs and displays. To learn about how to include media in your theme, refer to <a href="/themes/product-merchandising/media/support-media">Support product media</a>.

Anchor to

metafields

The metafields applied to the product.

Note

Only standard metafields set by the remote store are included. Custom metafields are not.

Note: Only standard metafields set by the remote store are included. Custom metafields are not.

Anchor to

options

array of string

The option names of the product.

Example

Output the options

You can use the size filter with dot notation to determine how many options a product has.

CodeData

Reset Code

9

1

2

3

4

5

{% if product.options.size > 0 -%}

{% for option in product.options -%}

- {{ option }}

{%- endfor %}

{%- endif %}

Code

{% if product.options.size > 0 -%}
  {% for option in product.options -%}
    - {{ option }}
  {%- endfor %}
{%- endif %}

Data

{
  "product": {
    "options": [
      "Size",
      "Strength"
    ]
  }
}

Output

9

1

2

- Size

- Strength

Output

- Size
- Strength

Anchor to

options_by_name

Allows you to access a specific product option by its name.

Example

Output the values for a specific option

When accessing a specific option, the name is case-insensitive.

CodeData

Reset Code

9

1

2

3

4

5

6

7

8

<label>

Strength

<select>

{%- for value in product.options_by_name['strength'].values %}

<option>{{ value }}</option>

{%- endfor %}

</select>

</label>

Code

<label>
  Strength
  <select>
    {%- for value in product.options_by_name['strength'].values %}
    <option>{{ value }}</option>
    {%- endfor %}
  </select>
</label>

Data

{
  "product": {
    "options_by_name": {}
  }
}

Output

9

1

2

3

4

5

6

7

8

<label>

Strength

<select>

<option>Low</option>

<option>Medium</option>

<option>High</option>

</select>

</label>

Output

<label>
  Strength
  <select>
    <option>Low</option>
    <option>Medium</option>
    <option>High</option>
  </select>
</label>

Anchor to

options_with_values

array of product_option

The options on the product.

Anchor to

price

number

The lowest price of any variants of the product in the currency's subunit.

Note

This is the same value as product.price_min.

Note: This is the same value as <a href="/docs/api/liquid/objects/product#product-price_min"><code><span class="PreventFireFoxApplyingGapToWBR">product.price<wbr/>_min</span></code></a>.

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.

Anchor to

price_max

number

The highest price of any variants of the product 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.

Anchor to

price_min

number

The lowest price of any variants of the product in the currency's subunit.

Note

This is the same value as product.price.

Note: This is the same value as <a href="/docs/api/liquid/objects/product#product-price"><code>product.price</code></a>.

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.

Anchor to

price_varies

boolean

Returns true if the product's variant prices vary. Returns false if not.

Anchor to

published_at

string

A timestamp for when the product was published.

Tip

Use the date filter to format the timestamp.

Tip: Use the <a href="/docs/api/liquid/filters/date"><code>date</code> filter</a> to format the timestamp.

Anchor to

quantity_price_breaks_configured?

boolean

Returns true if the product has at least one variant with quantity price breaks in the current customer context. Returns false if not.

Anchor to

remote_details

remote_details

Information about the remote source from which the remote product came from.

Anchor to

requires_selling_plan

boolean

Returns true if all of the variants of the product require a selling plan. Returns false if not.

Note

A variant requires a selling plan if variant.requires_selling_plan is true.

Note: A variant requires a selling plan if <a href="/docs/api/liquid/objects/variant#variant-requires_selling_plan"><code><span class="PreventFireFoxApplyingGapToWBR">variant.requires<wbr/>_selling<wbr/>_plan</span></code></a> is <code>true</code>.

Anchor to

selected_or_first_available_selling_plan_allocation

selling_plan_allocation

The currently selected, or first available, selling plan allocation.

The following logic is used to determine which selling plan allocation is returned:

Selling plan allocation	Return criteria
The currently selected allocation	Returned if a variant and selling plan are selected. The selected variant is determined by the variant URL parameter, and the selected selling plan is determined by the selling_plan URL parameter.
The first allocation on the first available variant	Returned if no allocation is currently selected.
The first allocation on the first variant	Returned if no allocation is currently selected, and there are no available variants.

If the product doesn't have any selling plans, then nil is returned.

Anchor to

selected_or_first_available_variant

variant

The currently selected or first available variant of the product.

If a variant is selected, it will be returned, regardless of its availability. Otherwise, the first available variant is returned. If no available variant exists, the first variant is returned.

A selected variant is determined by the following criteria:

• On product pages, it is based on the variant ID set in the variant URL parameter.
• In search results and filtered collections, it is the most relevant variant based on search terms and applied filters.

For a variant to be available, it needs to meet one of the following criteria:

• The variant.inventory_quantity is greater than 0.
• The variant.inventory_policy is set to continue.
• The variant.inventory_management is nil.

Anchor to

selected_selling_plan

selling_plan

The currently selected selling plan.

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><span class="PreventFireFoxApplyingGapToWBR">selling<wbr/>_plan</span></code> URL parameter.

Anchor to

selected_selling_plan_allocation

selling_plan_allocation

The currently selected selling plan allocation for the currently selected variant.

If no variant and selling plan are selected, then nil is returned.

Note

The selected variant is determined by the variant URL parameter, and the selected selling plan is determined by the selling_plan URL parameter.

Note: The selected variant is determined by the <code>variant</code> URL parameter, and the selected selling plan is determined by the <code><span class="PreventFireFoxApplyingGapToWBR">selling<wbr/>_plan</span></code> URL parameter.

Anchor to

selected_variant

variant

The currently selected variant of the product.

If no variant is currently selected, then nil is returned.

Note

On product pages, it is based on the variant ID set in the variant URL parameter. In search results and filtered collections, it is the most relevant variant based on search terms and applied filters.

Note: On product pages, it is based on the variant ID set in the <code>variant</code> URL parameter. In search results and filtered collections, it is the most relevant variant based on search terms and applied filters.

Anchor to

selling_plan_groups

array of selling_plan_group

The selling plan groups that the variants of the product are included in.

Anchor to

template_suffix

string

The name of the custom template assigned to the product.

Note

Remote products have pre-determined dedicated template names, always prefixed with "remote." This allows them to be managed independently of regular product templates. E.g. "remote.seller"

Note: Remote products have pre-determined dedicated template names, always prefixed with &quot;remote.&quot; This allows them to be managed independently of regular product templates. E.g. &quot;remote.seller&quot;

Anchor to

title

string

The title of the product.

Note

In a cart context, the title of a remote product is appended with "Sold by {store name}".

Note: In a cart context, the title of a remote product is appended with &quot;Sold by {store name}&quot;.

Anchor to

type

string

The type of the product.

Anchor to

url

string

The relative URL of the product.

If a product is rendered in search results or a filtered collection, then the URL contains the variant parameter of the most relevant variant.

Copy

9

1

/products/gorgeous-wooden-computer?variant=1234567890

/products/gorgeous-wooden-computer?variant=1234567890

If a product is rendered as a product recommendation, then the URL contains tracking parameters:

Copy

9

1

/products/gorgeous-wooden-computer?pr_choice=default&pr_prod_strat=description&pr_rec_pid=13&pr_ref_pid=17&pr_seq=alternating

/products/gorgeous-wooden-computer?pr_choice=default&pr_prod_strat=description&pr_rec_pid=13&pr_ref_pid=17&pr_seq=alternating

Anchor to

variants

array of variant

The variants of the product.

Note

Returns a maximum of 250 variants when unpaginated. Tip: Use the paginate tag to choose how many variants to show per page, up to a limit of 50.

Note: Returns a maximum of 250 variants when unpaginated. Tip: Use the <a href="/docs/api/liquid/tags/paginate">paginate</a> tag to choose how many variants to show per page, up to a limit of 50.

Anchor to

variants_count

number

The total number of variants for the product.

Anchor to

vendor

string

The vendor of the product.