Zone objects

Objects carry store data into templates. The field lists below are the fields the engine actually resolves.

This page is not hand-written: it is generated from the Zone engine's registry. Every name listed here actually works in the engine.

Summaries come straight from the source specification. Some summaries, syntax and examples are generated from MIT-licensed open specification data. Third-party licence notice

address

An address, such as a customer address or order shipping address.

Fields	Type	Description
`address1`	string	The first line of the address.
`address2`	string	The second line of the address.
`city`	string	The city of the address.
`company`	string	The company of the address.
`country`	country	The country of the address.
`country_code`	string	The country of the address in ISO 3166-1 (alpha 2) format.
`first_name`	string	The first name of the address.
`id`	number	The ID of the address.
`last_name`	string	The last name of the address.
`name`	string	A combination of the first and last names of the address.
`phone`	string	The phone number of the address.
`province`	string	The province of the address.
`province_code`	string	The province of the address in ISO 3166-2 (alpha 2) format.
`street`	string	A combination of the first and second lines of the address.
`summary`	string	A summary of the address, including the following properties: - First and last name - First and second lines - City - Province - Country
`url`	string	The relative URL for the address.
`zip`	string	The zip or postal code of the address.

all_country_option_tags

Creates an `<option>` tag for each country.

Returns: string

A single value; it has no fields.

all_products

All of the products on a store.

Returns: array<product>

A single value; it has no fields.

app

An app. This object is usually used to access app-specific information for use with theme app extensions.

Fields	Type	Description
`metafields`		The metafields that are owned by the app.

article

An article, or blog post, in a blog.

Fields	Type	Description
`author`	string	The full name of the author of the article.
`comment_post_url`	string	The relative URL where POST requests are sent when creating new comments.
`comments`	array<comment>	The published comments for the article.
`comments_count`	number	The number of published comments for the article.
`comments_enabled?`	boolean	Returns `true` if comments are enabled. Returns `false` if not.
`content`	string	The content of the article.
`created_at`	string	A timestamp for when the article was created.
`excerpt`	string	The excerpt of the article.
`excerpt_or_content`	string	Returns the article excerpt if it exists. Returns the article content if no excerpt exists.
`handle`	string	The handle of the article.
`id`	string	The ID of the article.
`image`	image	The featured image for the article.
`metafields`	untyped	The metafields applied to the article.
`moderated?`	boolean	Returns `true` if the blog that the article belongs to is set to moderate comments. Returns `false` if not.
`published_at`	string	A timestamp for when the article was published.
`tags`	array<string>	The tags applied to the article.
`template_suffix`	string	The name of the custom template assigned to the article.
`title`	string	The title of the article.
`updated_at`	string	A timestamp for when the article was updated.
`url`	string	The relative URL of the article.
`user`	user	The user associated with the author of the article.

articles

All of the articles across the blogs in the store.

Returns: array<article>

A single value; it has no fields.

block

The content and settings of a section block.

Fields	Type	Description
`id`	string	The ID of the block.
`settings`	untyped	The settings of the block.
`type`	string	The type of the block.

blog

Information about a specific blog in the store.

Fields	Type	Description
`all_tags`	array<string>	All of the tags on the articles in the blog.
`articles`	array<article>	The articles in the blog.
`articles_count`	number	The total number of articles in the blog. This total doesn't include hidden articles.
`comments_enabled?`	boolean	Returns `true` if comments are enabled for the blog. Returns `false` if not.
`handle`	string	The handle of the blog.
`id`	number	The ID of the blog.
`metafields`	array<metafield>	The metafields applied to the blog.
`moderated?`	boolean	Returns `true` if the blog is set to moderate comments. Returns `false` if not.
`next_article`	article	The next (older) article in the blog.
`previous_article`	article	The previous (newer) article in the blog.
`tags`	array<string>	A list of all of the tags on all of the articles in the blog. Unlike `blog.all_tags`, this property only returns tags of articles that are in the filtered view.
`template_suffix`	string	The name of the custom template assigned to the blog.
`title`	string	The title of the blog.
`url`	string	The relative URL of the blog.

blogs

All of the blogs in the store.

Returns: array<blog>

A single value; it has no fields.

brand

The brand assets for the store.

Fields	Type	Description
`colors`		The brand's colors.
`cover_image`	image	The square logo for the brand, resized to 32x32 px.
`favicon_url`	image	The square logo for the brand, resized to 32x32 px.
`logo`	image	The default logo for the brand.
`metafields`		The social links for the brand.
`short_description`	string	A short description of the brand.
`slogan`	string	The slogan for the brand.
`square_logo`	image	The square logo for the brand.

brand_color

The colors defined as part of a store's brand assets.

Returns: string

A single value; it has no fields.

canonical_url

The canonical URL for the current page.

Returns: string

A single value; it has no fields.

cart

A customer’s cart.

Fields	Type	Description
`attributes`	untyped	Additional attributes entered by the customer with the cart.
`cart_level_discount_applications`	array<discount_application>	The cart-specific discount applications for the cart.
`checkout_charge_amount`	number	The amount that the customer will be charged at checkout in the currency's subunit.
`currency`		The currency of the cart.
`discount_applications`	array<discount_application>	The discount applications for the cart.
`discounts`	array<discount>	The discounts applied to the cart.
`duties_included`	boolean	Returns `true` if duties are included in the prices of products in the cart. Returns `false` if not.
`empty?`	boolean	Returns `true` if there are no items in the cart. Return's `false` if there are.
`item_count`	number	The number of items in the cart.
`items`	array<line_item>	The line items in the cart.
`items_subtotal_price`	number	The total price of all of the items in the cart in the currency's subunit, after any line item discounts. This doesn't include taxes (unless taxes are included in the prices), cart discounts, or shipping costs.
`note`	string	Additional information captured with the cart.
`original_total_price`	number	The total price of all of the items in the cart in the currency's subunit, before discounts have been applied.
`requires_shipping`	boolean	Returns `true` if any of the products in the cart require shipping. Returns `false` if not.
`taxes_included`	boolean	Returns `true` if taxes are included in the prices of products in the cart. Returns `false` if not.
`total_discount`	number	The total amount of all discounts (the amount saved) for the cart in the currency's subunit.
`total_price`	number	The total price of all of the items in the cart in the currency's subunit, after discounts have been applied.
`total_weight`	number	The total weight of all of the items in the cart in grams.

checkout

A customer's checkout.

Fields	Type	Description
`applied_gift_cards`	array<gift_card>	The gift cards applied to the checkout.
`attributes`	untyped	Additional attributes entered by the customer with the cart.
`billing_address`	address	The billing address entered at checkout.
`buyer_accepts_marketing`	boolean	Returns `true` if the customer checks the email marketing subscription checkbox. Returns `false` if not.
`cancelled`	boolean	Returns `true` if the checkout has been cancelled. Returns `false` if not.
`cart_level_discount_applications`	array<discount_application>	The cart-specific discount applications for the checkout.
`currency`	string	The ISO code of the currency of the checkout.
`customer`	customer	The customer associated with the checkout. > Note: > The `customer` object is directly accessible globally when a customer is logged in to their account.
`discount`	discount	A discount applied to the checkout without being saved.
`discount_applications`	array<discount_application>	The discount applications for the checkout.
`discounts`	array<discount>	The discounts applied to the checkout.
`discounts_amount`	array<discount_application>	The total amount of the discounts applied to the checkout in the currency's subunit.
`discounts_savings`	array<discount_application>	The total amount of the discounts applied to the checkout in the currency's subunit, as a negative value.
`email`	string	The email associated with the checkout.
`financial_status`	string	The financial status of the checkout.
`fulfilled_at`	string	A timestamp for the fulfullment of the checkout.
`fulfilled_line_items`	array<line_item>	The fulfilled line items from the checkout.
`fulfillment_status`	string	The fulfillment status of the checkout.
`gift_cards_amount`	number	The amount of the checkout price paid in gift cards.
`id`	number	The ID of the checkout.
`item_count`	number	The number of items in the checkout.
`line_items`	array<line_item>	The line items of the checkout.
`line_items_subtotal_price`	number	The sum of the prices of all of the line items of the checkout in the currency's subunit, after any line item discounts. have been applied.
`name`	number	The name of the checkout.
`note`	string	Additional information entered by the customer with the cart.
`order`	order	The order created by the checkout.
`order_id`	string	The ID of the order created by the checkout.
`order_name`	string	The name of the order created by the checkout.
`order_number`	string	An integer representation of the name of the order created by the checkout.
`requires_shipping`	boolean	Returns `true` if any of the line items of the checkout require shipping. Returns `false` if not.
`shipping_address`	address	The shipping address of the checkout.
`shipping_method`	shipping_method	The shipping method of the checkout.
`shipping_price`	number	The shipping price of the checkout in the currency's subunit.
`tax_lines`	array<tax_line>	The tax lines for the checkout.
`tax_price`	number	The total tax amount of the checkout in the currency's subunit.
`total_price`	number	The total price of the checkout in the currency's subunit.
`transactions`	array<transaction>	The transactions of the checkout.
`unavailable_line_items`	array<line_item>	The unavailable line items of the checkout.
`unfulfilled_line_items`	array<line_item>	The unfulfilled line items of the checkout.

closest

A drop that holds resources of different types that are the closest to the current context

Fields	Type	Description
`article`	article	Closest article resource
`blog`	blog	Closest blog resource
`collection`	collection	Closest collection resource
`metaobject`	metaobject	Closest metaobject resources
`page`	page	Closest page resource
`product`	product	Closest product resource

collection

A collection in a store.

Fields	Type	Description
`all_products_count`	number	The total number of products in a collection.
`all_tags`	array<string>	All of the tags applied to the products in the collection.
`all_types`	array<string>	All of the product types in a collection.
`all_vendors`	array<string>	All of the product vendors in a collection.
`current_type`	string	The product type on a product type collection page.
`current_vendor`	string	The vendor name on a vendor collection page.
`default_sort_by`	string \| string \| string \| string \| string \| string \| string	The default sort order of the collection.
`description`	string	The description of the collection.
`featured_image`	image	The featured image for the collection.
`filters`	array<filter>	The storefront filters that have been set up on the collection.
`handle`	string	The handle of the collection.
`id`	number	The ID of the collection.
`image`	image	The image for the collection.
`metafields`	array<metafield>	The metafields applied to the collection.
`next_product`	product	The next product in the collection. Returns `nil` if there's no next product.
`previous_product`	product	The previous product in the collection. Returns `nil` if there's no previous product.
`products`	array<product>	All of the products in the collection.
`products_count`	number	The total number of products in the current view of the collection.
`published_at`	string	A timestamp for when the collection was published.
`sort_by`	string	The sort order applied to the collection by the `sort_by` URL parameter.
`sort_options`	array<sort_option>	The available sorting options for the collection.
`tags`	array<string>	The tags that are currently applied to the collection.
`template_suffix`	string	The name of the custom template assigned to the collection.
`title`	string	The title of the collection.
`url`	string	The relative URL of the collection.

collections

All of the collections on a store.

Returns: array<collection>

A single value; it has no fields.

color

A color from a `color` setting.

Fields	Type	Description
`alpha`	number	The alpha component of the color, which is a decimal number between 0.0 and 1.0.
`blue`	number	The blue component of the color, which is a number between 0 and 255.
`chroma`	number	The chroma component of the color, which is a decimal number between 0.0 and 0.5.
`color_space`	string	The color space of the color. Returns 'srgb' or 'oklch'
`green`	number	The green component of the color, which is a number between 0 and 255.
`hue`	number	The hue component of the color, which is a number between 0 and 360.
`lightness`	number	The lightness component of the color, which is a number between 0 and 100.
`oklch`	string	The lightness, chroma, and hue values of the color, represented as a space-separated string.
`oklcha`	string	The lightness, chroma, hue and alpha values of the color, represented as a space-separated string, with a slash before the alpha channel.
`red`	number	The red component of the color, which is a number between 0 and 255.
`rgb`	string	The red, green, and blue values of the color, represented as a space-separated string.
`rgba`	string	The red, green, blue, and alpha values of the color, represented as a space-separated string, with a slash before the alpha channel.
`saturation`	number	The saturation component of the color, which is a number between 0 and 100.

color_scheme

A color_scheme from a `color_scheme` setting.

Fields	Type	Description
`id`	string	The ID of the color_scheme
`settings`	untyped	The settings of the color_scheme.

color_scheme_group

A color_scheme_group from a `color_scheme_group` setting.

A single value; it has no fields.

comment

An article comment.

Fields	Type	Description
`author`	string	The full name of the author of the comment.
`content`	string	The content of the comment.
`created_at`	string	A timestamp for when the comment was created.
`email`	string	The email of he author of the comment.
`id`	number	The ID of the comment.
`status`	string	The status of the comment. Always returns `published`.
`updated_at`	string	A timestamp for when the status of the comment was last updated.
`url`	string	The relative URL of the article that the comment is associated with, with `comment.id` appended.

company

A company that a customer is purchasing for.

Fields	Type	Description
`available_locations`	array<company_location>	The company locations that the current customer has access to, or can interact with.
`available_locations_count`	number	The number of company locations associated with the customer's company.
`external_id`	string	The external ID of the company.
`id`	number	The ID of the company.
`metafields`	array<metafield>	The metafields applied to the company.
`name`	string	The name of the company.

company_address

The address of a company location.

Fields	Type	Description
`address1`	string	The first line of the address.
`address2`	string	The second line of the address.
`attention`	string	The attention line of the address.
`city`	string	The city of the address.
`country`	country	The country of the address.
`country_code`	string	The country of the address in ISO 3166-1 (alpha 2) format.
`first_name`	string	The first name of the address.
`id`	number	The ID of the address.
`last_name`	string	The last name of the address.
`province`	string	The province of the address.
`province_code`	string	The province of the address in ISO 3166-2 (alpha 2) format.
`street`	string	A combination of the first and second lines of the address.
`zip`	string	The zip or postal code of the address.

company_location

A location of the company that a customer is purchasing for.

Fields	Type	Description
`company`	company	The company that the location is associated with.
`current?`	boolean	Returns `true` if the location is currently selected. Returns `false` if not.
`external_id`	string	The external ID of the location.
`id`	number	The ID of the location.
`metafields`	array<metafield>	The metafields applied to the company location.
`name`	string	The name of the location.
`shipping_address`	company_address	The address of the location.
`store_credit_account`	store_credit_account	The store credit account associated with the company location.
`tax_registration_id`	number	The tax ID of the location.
`url_to_set_as_current`	string	The URL to set the location as the current location for the customer.

content_for_header

A single value; it has no fields.

content_for_index

Dynamically returns the content of sections to be rendered on the home page.

Returns: string

A single value; it has no fields.

content_for_layout

Dynamically returns content based on the current template.

Returns: string

A single value; it has no fields.

country

A country supported by the store's localization options.

Fields	Type	Description
`available_languages`	array<shop_locale>	The languages that have been added to the market that this country belongs to.
`continent`	string	The continent that the country is in.
`currency`	currency	The currency used in the country.
`iso_code`	string	The ISO code of the country in ISO 3166-1 (alpha 2) format.
`market`	market	The market that includes this country.
`name`	string	The name of the country.
`popular?`	boolean	Returns `true` if the country is popular for this shop. Otherwise, returns `false`. This can be useful for sorting countries in a country selector.
`unit_system`	string \| string	The unit system of the country.

country_option_tags

Returns: string

A single value; it has no fields.

currency

Information about a currency, like the ISO code and symbol.

Fields	Type	Description
`iso_code`	string	The ISO code of the currency.
`name`	string	The name of the currency.
`symbol`	string	The symbol of the currency.

current_page

The current page number.

Returns: number

A single value; it has no fields.

current_tags

The currently applied tags.

Returns: array<string>

A single value; it has no fields.

customer

A customer of the store.

Fields	Type	Description
`accepts_marketing`	boolean	Returns `true` if the customer accepts marketing. Returns `false` if not.
`addresses`	array<address>	All of the addresses associated with the customer.
`addresses_count`	number	The number of addresses associated with the customer.
`b2b?`	boolean	Returns `true` if the customer is a B2B customer. Returns `false` if not.
`company_available_locations`	array<company_location>	The company locations that the customer has access to, or can interact with.
`company_available_locations_count`	number	The number of company locations associated with the customer.
`current_company`	company	The company that the customer is purchasing for.
`current_location`	company_location	The currently selected company location.
`default_address`	address	The default address of the customer.
`email`	string	The email of the customer.
`first_name`	string	The first name of the customer.
`has_account`	boolean	Returns `true` if the email associated with the customer is tied to a customer account. Returns `false` if not.
`has_avatar?`	boolean	Returns `true` if an avatar is associated with a customer. Returns `false` if not.
`id`	number	The ID of the customer.
`last_name`	string	The last name of the customer.
`last_order`	order	The last order placed by the customer, not including test orders.
`name`	string	The full name of the customer.
`orders`	array<order>	All of the orders placed by the customer.
`orders_count`	number	The total number of orders that the customer has placed.
`payment_methods`	array<customer_payment_method>	The customer's saved payment methods.
`phone`	string	The phone number of the customer.
`store_credit_account`	store_credit_account	The store credit account associated with the customer.
`tags`	array<string>	The tags associated with the customer.
`tax_exempt`	boolean	Returns `true` if the customer is exempt from taxes. Returns `false` if not.
`total_spent`	number	The total amount that the customer has spent on all orders in the currency's subunit.

customer_payment_method

A customer's saved payment method.

Fields	Type	Description
`payment_instrument_type`	string	The instrument type of the payment method (e.g credit_card).
`token`	string	The identifier for the payment method.

discountDeprecated

A discount applied to a cart, line item, or order.

Fields	Type	Description
`amount`	number	The amount of the discount in the currency's subunit.
`code`	string	The customer-facing name of the discount.
`savings`	number	The amount of the discount as a negative value, in the currency's subunit.
`title`	string	The customer-facing name of the discount.
`total_amount`	number	The amount of the discount in the currency's subunit.
`total_savings`	number	The amount of the discount as a negative value, in the currency's subunit.
`type`	string \| string \| string	The type of the discount.

discount_allocation

Information about how a discount affects an item.

Fields	Type	Description
`amount`	number	The amount that the item is discounted by in the currency's subunit.
`discount_application`	discount_application	The discount application that applies the discount to the item.

discount_application

Information about the intent of a discount.

Fields	Type	Description
`target_selection`	string \| string \| string	The selection method for line items or shipping lines to be discounted.
`target_type`	string \| string	The type of item that the discount applies to.
`title`	string	The customer-facing name of the discount.
`total_allocated_amount`	number	The total amount of the discount in the currency's subunit.
`type`	string \| string \| string \| string	The type of the discount.
`value`	number	The value of the discount.
`value_type`	string \| string	The value type of the discount.

external_video

Information about an external video from YouTube or Vimeo.

Fields	Type	Description
`alt`	string	The alt text of the external video.
`aspect_ratio`	number	The aspect ratio of the video as a decimal.
`external_id`	string	The ID of the video from its external source.
`host`	string \| string	The service that hosts the video.
`id`	number	The ID of the external video.
`media_type`	string	The media type of the external video. Always returns `external_video`.
`position`	number	The position of the external video in the `product.media` array.
`preview_image`	image	A preview image of the media.

filter

A storefront filter.

Fields	Type	Description
`active_values`	array<filter_value>	The values of the filter that are currently active. The array can have values only for `boolean` and `list` type filters.
`false_value`	filter_value	The `false` filter value. Returns a value for `boolean` type filters if the unfiltered view has at least one result with the `false` filter value. Otherwise, it returns `nil`.
`inactive_values`	array<filter_value>	The values of the filter that are currently inactive.
`label`	string	The customer-facing label for the filter.
`max_value`	filter_value	The highest filter value. Returns a value only for `price_range` type filters. Returns `nil` for other types.
`min_value`	filter_value	The lowest filter value. Returns a value only for `price_range` type filters. Returns `nil` for other types.
`operator`	string \| string	The logical operator used by the filter. Returns a value only for `boolean` and `list` type filters. Returns `nil` for other types.
`param_name`	string	The URL parameter for the filter. For example, `filter.v.option.color`.
`presentation`	string \| string \| string	Describes how to present the filter values. Returns a value only for `list` type filters. Returns `nil` for other types.
`range_max`	number	The highest product price within the collection or search results. Returns a value only for `price_range` type filters. Returns `nil` for other types.
`true_value`	filter_value	The `true` filter value. Returns a value for `boolean` type filters if the unfiltered view has at least one result with the `true` filter value. Otherwise, it returns `nil`.
`type`	string \| string \| string	The type of the filter.
`url_to_remove`	string	The current page URL with the URL parameter related to the filter removed.
`values`	array<filter_value>	The values of the filter. The array can have values only for `boolean` and `list` type filters.

filter_value

A specific value of a filter.

Fields	Type	Description
`active`	boolean	Returns `true` if the value is currently active. Returns `false` if not. Can only return `true` for filters of type `boolean` or `list`.
`count`	number	The number of results related to the filter value. Returns a value only for `boolean` and `list` type filters. Returns `nil` for `price_range` type filters.
`display`	filter_value_display	The visual representation of the filter value.
`image`	image	The visual representation of the filter value when an image is used.
`label`	string	The customer-facing label for the filter value. For example, `Red` or `Rouge`. Returns a value only for `boolean` and `list` type filters. Returns `nil` for `price_range` type filters.
`param_name`	string	The URL parameter for the parent filter of the filter value.
`swatch`	swatch	The visual representation of the filter value when a swatch is used.
`url_to_add`	string	The current page URL with the filter value parameter added.
`url_to_remove`	string	The current page URL with the filter value parameter removed.
`value`	string	The value for the URL parameter. The `value` is paired with the `param_name` property.

filter_value_displayDeprecated

The visual representation of a filter value.

Fields	Type	Description
`type`	string \| string	The type of visual representation.
`value`	untyped	The visual representation.

focal_point

The focal point for an image.

Fields	Type	Description
`x`	number	The horizontal position of the focal point, as a percent of the image width. Returns `50` if no focal point is set.
`y`	number	The vertical position of the focal point, as a percent of the image height. Returns `50` if no focal point is set.

font

A font from a `font_picker` setting.

Fields	Type	Description
`baseline_ratio`	number	The baseline ratio of the font as a decimal.
`fallback_families`	string	The fallback families of the font.
`family`	string	The family name of the font.
`style`	string	The style of the font.
`system?`	boolean	Returns `true` if the font is a system font. Returns `false` if not.
`variants`	array<font>	The variants in the family of the font.
`weight`	number	The weight of the font.

forloop

Information about a parent `for` loop.

Fields	Type	Description
`first`	boolean	Returns `true` if the current iteration is the first. Returns `false` if not.
`index`	number	The 1-based index of the current iteration.
`index0`	number	The 0-based index of the current iteration.
`last`	boolean	Returns `true` if the current iteration is the last. Returns `false` if not.
`length`	number	The total number of iterations in the loop.
`parentloop`	forloop	The parent `forloop` object.
`rindex`	number	The 1-based index of the current iteration, in reverse order.
`rindex0`	number	The 0-based index of the current iteration, in reverse order.

form

Information about a form created by a `form` tag.

Fields	Type	Description
`address1`	string	The first address line associated with the address.
`address2`	string	The second address line associated with the address.
`author`	string	The name of the author of the article comment.
`body`	string	The content of the contact submission or article comment.
`city`	string	The city associated with the address.
`company`	string	The company associated with the address.
`country`	string	The country associated with the address.
`email`	string	The email associated with the form.
`errors`	form_errors	Any errors from the form.
`first_name`	string	The first name associated with the customer or address.
`id`	string	The ID of the form.
`last_name`	string	The last name associated with the customer or address.
`message`	string	The personalized message intended for the recipient.
`name`	string	The nickname of the gift card recipient.
`password_needed`	boolean	Returns `true`.
`phone`	string	The phone number associated with the address.
`posted_successfully?`	boolean	Returns `true` if the form was submitted successfully. Returns `false` if there were errors.
`province`	string	The province associated with the address.
`set_as_default_checkbox`	string	Renders an HTML checkbox that can submit the address as the customer's default address.
`zip`	string	The zip or postal code associated with the address.

form_errors

The error category strings for errors from a form created by a `form` tag.

Returns: array<string>

Fields	Type	Description
`messages`	array<string>	The translated error messages for each value in the `form_errors` array.
`translated_fields`	array<string>	The translated names for each value in the `form_errors` array.

fulfillment

An order fulfillment, which includes information like the line items being fulfilled and shipment tracking.

Fields	Type	Description
`created_at`	string	A timestamp for when the fulfillment was created.
`fulfillment_line_items`	array<line_item>	The line items in the fulfillment.
`item_count`	number	The number of items in the fulfillment.
`tracking_company`	string	The name of the fulfillment service.
`tracking_number`	string	The fulfillment's tracking number.
`tracking_numbers`	array<string>	An array of the fulfillment's tracking numbers.
`tracking_url`	string	The URL for the fulfillment's tracking number.

generic_file

A file from a `file_reference` type metafield that is neither an image or video.

Fields	Type	Description
`alt`	string	The alt text of the media.
`id`	number	The ID of the file.
`media_type`	string	The media type of the model. Always returns `generic_file`.
`position`	number	The position of the media in the `product.media` array.
`preview_image`	image	A preview image for the file.
`url`	string	The CDN URL for the file.

gift_card

A gift card that's been issued to a customer or a recipient.

Fields	Type	Description
`balance`	number	The remaining balance of the gift card in the currency's subunit.
`code`	string	The code used to redeem the gift card.
`currency`	string	The ISO code of the currency that the gift card was issued in.
`customer`	customer	The customer associated with the gift card.
`enabled`	boolean	Returns `true` if the gift card is enabled. Returns `false` if not.
`expired`	boolean	Returns `true` if the gift card is expired. Returns `false` if not.
`expires_on`	string	A timestamp for when the gift card expires.
`initial_value`	number	The initial balance of the gift card in the currency's subunit.
`last_four_characters`	string	The last 4 characters of the code used to redeem the gift card.
`message`	string	The personalized message intended for the recipient.
`pass_url`	string	The URL to download the gift card as an Apple Wallet Pass.
`product`	product	The product associated with the gift card.
`properties`	array<untyped>	The line item properties assigned to the gift card.
`qr_identifier`	string	A string used to generate a QR code for the gift card.
`recipient`	recipient	The recipient associated with the gift card.
`send_on`	string	The scheduled date on which the gift card will be sent to the recipient.
`template_suffix`	string	The name of the custom template assigned to the gift card.
`url`	string
`variant`	variant	The variant associated with the gift card.

group

A group of rules for the `robots.txt` file.

Fields	Type	Description
`rules`	array<rule>	The rules in the group.
`sitemap`	sitemap	The sitemap for the group.
`user_agent`	user_agent	The user agent for the group.

handle

The handle of the resource associated with the current template.

Returns: string

A single value; it has no fields.

image

An image, such as a product or collection image.

Returns: array<image>

Fields	Type	Description
`alt`	string	The alt text of the image.
`aspect_ratio`	number	The aspect ratio of the image as a decimal.
`attached_to_variant?`	boolean	Returns `true` if the image is associated with a variant. Returns `false` if not.
`height`	number	The height of the image in pixels.
`id`	number	The ID of the image.
`media_type`	string	The media type of the image. Always returns `image`.
`position`	number	The position of the image in the `product.images` or `product.media` array.
`presentation`	image_presentation	The presentation settings for the image.
`preview_image`	image	A preview image for the image.
`product_id`	number	The ID of the product that the image is associated with.
`src`	string	The relative URL of the image.
`variants`	array<variant>	The product variants that the image is associated with.
`width`	number	The width of the image in pixels.

image_presentation

The presentation settings for an image.

Fields	Type	Description
`focal_point`	focal_point	The focal point for the image.

images

All of the images that have been uploaded to a store.

Returns: array<image>

A single value; it has no fields.

instructions

The instructions for a nested cart line item.

Fields	Type	Description
`can_remove`	boolean	Whether the nested cart line item can be removed.
`can_update_quantity`	boolean	Whether the nested cart line item quantity can be updated.

line_item

A line in a cart, checkout, or order. Each line item represents a product variant.

Fields	Type	Description
`discount_allocations`	array<discount_allocation>	The discount allocations that apply to the line item.
`discounts`	array<discount>	The discounts applied to the line item.
`error_message`	string	An informational error message about the status of the line item in the buyer's chosen language.
`final_line_price`	number	The combined price, in the currency's subunit, of all of the items in the line item. This includes any line-level discounts.
`final_price`	number	The price of the line item in the currency's subunit. This includes any line-level discounts.
`fulfillment`	fulfillment	The fulfillment of the line item.
`fulfillment_service`	string	The fulfillment service for the vartiant associated with the line item. If there's no fulfillment service, then `manual` is returned.
`gift_card`	boolean	Returns `true` if the product associated with the line item is a gift card. Returns `false` if not.
`grams`	number	The weight of the line item in the store's default weight unit.
`id`	number	The ID of the line item.
`image`	image	The image of the line item.
`instructions`	instructions	Instructions define behaviours and operations that can be performed on the nested cart line.
`item_components`	array<line_item>	The components of a line item.
`key`	string	The key of the line item.
`line_level_discount_allocations`	array<discount_allocation>	The discount allocations that apply directly to the line item.
`line_level_total_discount`	number	The total amount of any discounts applied to the line item in the currency's subunit.
`line_price`	number
`message`	string	Information about the discounts that have affected the line item.
`options_with_values`	array<untyped>	The name and value pairs for each option of the variant associated with the line item.
`original_line_price`	number	The combined price of all of the items in a line item in the currency's subunit, before any discounts have been applied.
`original_price`	number	The price of the line item in the currency's subunit, before discounts have been applied.
`parent_relationship`	parent_relationship	The parent relationship for a nested line item.
`price`	number
`product`	product	The product associated with the line item. May be a regular product or a remote product.
`product_id`	number	The ID of the line item's product.
`properties`	array<untyped>	The properties of the line item.
`quantity`	number	The quantity of the line item.
`requires_shipping`	boolean	Returns `true` if the variant associated with the line item requires shipping. Returns `false` if not.
`selling_plan_allocation`	selling_plan_allocation	The selling plan allocation of the line item. If the line item doesn't have a selling plan allocation, then `nil` is returned.
`sku`	string	The sku of the variant associated with the line item.
`successfully_fulfilled_quantity`	number	The number of items from the line item that have been successfully fulfilled.
`tax_lines`	array<tax_line>	The tax lines for the line item.
`taxable`	boolean	Returns `true` if taxes should be charged on the line item. Returns `false` if not.
`title`	string	The title of the line item. The title is a combination of `line_item.product.title` and `line_item.variant.title`, separated by a hyphen.
`total_discount`	number
`unit_price`	number	The unit price of the line item in the currency's subunit.
`unit_price_measurement`	unit_price_measurement	The unit price measurement of the line item.
`url`	string	The relative URL of the variant associated with the line item.
`url_to_remove`	string	A URL to remove the line item from the cart.
`variant`	variant	The variant associated with the line item.
`variant_id`	number	The ID of the line item's variant.
`vendor`	string	The vendor of the variant associated with the line item.

link

A link in a menu.

Fields	Type	Description
`active`	boolean	Returns `true` if the link is active. Returns `false` if not.
`child_active`	boolean	Returns `true` if a link's child link is active. Returns `false` if not.
`child_current`	boolean	Returns `true` if current URL path matches a link's child link URL. Returns `false` if not.
`current`	boolean	Returns `true` if the current URL path matches the URL of the link. Returns `false` if not.
`handle`	string	The handle of the link.
`levels`	number	The number of nested levels under the link.
`links`	array<link>	The child links of the link.
`object`	untyped	The object associated with the link.
`title`	string	The title of the link.
`type`	string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string	The type of the link.
`url`	string	The URL of the link.

linklist

A menu in a store.

Fields	Type	Description
`handle`	string	The handle of the menu.
`levels`	number	The number of nested levels in the menu.
`links`	array<link>	The links in the menu.
`title`	string	The title of the menu.

linklists

All of the menus in a store.

Returns: array<linklist>

A single value; it has no fields.

localization

Information about the countries and languages that are available on a store.

Fields	Type	Description
`available_countries`	array<country>	The countries that are available on the store.
`available_languages`	array<shop_locale>	The languages that are available on the store.
`country`	country	The currently selected country on the storefront.
`language`	shop_locale	The currently selected language on the storefront.
`market`	market	The currently selected market on the storefront.

location

A store location.

Fields	Type	Description
`address`	address	The location's address.
`id`	number	The location's ID.
`latitude`	number	The latitude of the location's address.
`longitude`	number	The longitude of the location's address.
`metafields`	untyped	The metafields applied to the location.
`name`	string	The location's name.

market

A group of one or more regions of the world that a merchant is targeting for sales.

Fields	Type	Description
`handle`	string	The handle of the market.
`id`	string	The ID of the market.
`metafields`	array<metafield>	The metafields applied to the market.

measurement

A measurement from one of the following metafield types: - `dimension` - `volume` - `weight`

Fields	Type	Description
`type`	string \| string \| string	The measurement type.
`unit`	string	The measurement unit.
`value`	number	The measurement value.

media

An abstract media object that can represent the following object types: - `image` - `model` - `video` - `external_video`

Fields	Type	Description
`alt`	string	The alt text of the media.
`id`	number	The ID of the media.
`media_type`	string \| string \| string \| string	The media type.
`position`	number	The position of the media in the `product.media` array.
`preview_image`	image	A preview image of the media.

metafield

A metafield attached to a parent object.

Fields	Type	Description
`list?`	boolean	Returns `true` if the metafield is a list type. Returns `false` if not.
`type`	string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string	The type of the metafield.
`value`	untyped	The value of the metafield.

metaobject

A metaobject entry, which includes the values for a set of fields. The set is defined by the parent `metaobject_definition`.

Fields	Type	Description
`system`	metaobject_system	Basic information about the metaobject. These properties are grouped under the `system` object to avoid collisions between system property names and user-defined metaobject fields.

metaobject_definition

A `metaobject_definition` defines the structure of a metaobject type for the store, which consists of a merchant-defined set of field definitions.

Fields	Type	Description
`values`	array<metaobject>	The metaobjects that follow the definition.
`values_count`	number	The total number of entries for the metaobject definition.

metaobject_system

Basic information about a `metaobject`. These properties are grouped under the `system` object to avoid collisions between system property names and user-defined metaobject fields.

Fields	Type	Description
`handle`	string	The unique handle of the metaobject.
`id`	number	The ID of the metaobject.
`type`	string	The type of the metaobject definition.
`url`	string	The relative URL of the metaobject.

metaobjects

All of the metaobjects of the store.

A single value; it has no fields.

model

A 3D model uploaded as product media.

Fields	Type	Description
`alt`	string	The alt text of the model.
`id`	number	The ID of the model.
`media_type`	string	The media type of the model. Always returns `model`.
`position`	number	The position of the model in the `product.media` array.
`preview_image`	image	A preview image for the model.
`sources`	array<model_source>	The source files for the model.

model_source

A model source file.

Fields	Type	Description
`format`	string	The format of the model source file.
`mime_type`	string	The MIME type of the model source file.
`url`	string	The CDN URL of the model source file.

money

A money value, in the the customer's local (presentment) currency.

Fields	Type	Description
`currency`	currency	The customer's local (presentment) currency.

order

An order.

Fields	Type	Description
`attributes`	untyped	The attributes on the order.
`billing_address`	address	The billing address of the order.
`cancel_reason`	string \| string \| string \| string \| string \| string	The reason that the order was cancelled.
`cancel_reason_label`	string	The localized version of the cancellation reason for the order.
`cancelled`	boolean	Returns `true` if the order was cancelled. Returns `false` if not.
`cancelled_at`	string	A timestamp for when the order was cancelled.
`cart_level_discount_applications`	array<discount_application>	The discount applications that apply at the order level.
`confirmation_number`	string	A randomly generated alpha-numeric identifier for the order that may be shown to the customer instead of the sequential order name. For example, "XPAV284CT", "R50KELTJP" or "35PKUN0UJ". This value isn't guaranteed to be unique.
`created_at`	string	A timestamp for when the order was created.
`customer`	customer	The customer that placed the order.
`customer_order_url`	string	The URL for the new order details page.
`customer_url`	string	The URL for the customer to view the order in their account.
`discount_applications`	array<discount_application>	All of the discount applications for the order and its line items.
`discounts`	discount	The discounts on the order.
`email`	string	The email that's associated with the order.
`financial_status`	string \| string \| string \| string \| string \| string \| string \| string \| string	The order's financial status.
`financial_status_label`		The localized version of the financial status of the order.
`fulfillment_status`	string	The fulfillment status of the order.
`fulfillment_status_label`	string \| string \| string \| string \| string	The localized version of the fulfillment status of the order.
`id`	number	The ID of the order.
`item_count`	number	The number of items in the order.
`line_items`	array<line_item>	The line items in the order.
`line_items_subtotal_price`	number	The sum of the prices of all of the line items in the order in the currency's subunit, after any line item discounts have been applied.
`metafields`	untyped	The metafields applied to the order.
`name`	string	The name of the order.
`note`	string	The note on the order.
`order_number`	number	The integer representation of the order name.
`order_status_url`	string	The URL for the Order status page for the order.
`phone`	string	The phone number associated with the order.
`pickup_in_store?`	boolean	Returns `true` if the order is a store pickup order.
`shipping_address`	address	The shipping address of the order.
`shipping_methods`	array<shipping_method>	The shipping methods for the order.
`shipping_price`	number	The shipping price of the order in the currency's subunit.
`subtotal_line_items`	array<line_item>	The non-tip line items in the order.
`subtotal_price`	number	The sum of the prices of the subtotal line items in the currency's subunit, after any line item or cart discounts have been applied.
`tags`	array<string>	The tags on the order.
`tax_lines`	array<tax_line>	The tax lines on the order.
`tax_price`	number	The total amount of taxes applied to the order in the currency's subunit.
`total_discounts`	number	The total amount of all discounts applied to the order in the currency's subunit.
`total_duties`	number	The sum of all duties applied to the line items in the order in the currency's subunit.
`total_net_amount`	number	The net amount of the order in the currency's subunit.
`total_price`	number	The total price of the order in the currency's subunit.
`total_refunded_amount`	number	The total amount that's been refunded from the order in the currency's subunit.
`transactions`	array<transaction>	The transactions of the order.

page

A page on a store.

Fields	Type	Description
`author`	string	The author of the page.
`content`	string	The content of the page.
`handle`	string	The handle of the page.
`id`	number	The ID of the page.
`metafields`	untyped	The metafields applied to the page.
`published_at`	string	A timestamp for when the page was published.
`template_suffix`	string	The name of the custom template assigned to the page.
`title`	string	The title of the page.
`url`	string	The relative URL of the page.

page_description

The meta description of the current page.

Returns: string

A single value; it has no fields.

page_image

An image to be shown in search engine listings and social media previews for the current page.

Returns: image

A single value; it has no fields.

page_title

The page title of the current page.

Returns: string

A single value; it has no fields.

pages

All of the pages on a store.

Returns: array<page>

A single value; it has no fields.

paginate

Information about the pagination inside a set of `paginate` tags.

Fields	Type	Description
`current_offset`	number	The total number of items on pages previous to the current page.
`current_page`	number	The page number of the current page.
`items`	number	The total number of items to be paginated.
`next`	part	The pagination part to go to the next page.
`page_param`	string	The URL parameter denoting the pagination.
`page_size`	number	The number of items displayed per page.
`pages`	number	The total number of pages.
`parts`	array<part>	The pagination parts.
`previous`	part	The pagination part to go to the previous page.

parent_relationship

Information about the parent relationship for a nested cart line item.

Fields	Type	Description
`parent`	line_item	The parent line item for the nested cart line item.

part

A part in the navigation for pagination.

Fields	Type	Description
`is_link`	boolean	Returns `true` if the part is a link. Returns `false` if not.
`title`	string	The page number associated with the part.
`url`	string	The URL of the part.

pending_payment_instruction_input

Header-value pairs that make up the list of payment information specific to the payment method. This information can be be used by the customer to complete the transaction offline.

Fields	Type	Description
`header`	string	The header of the payment instruction. These are payment method-specific. Example: "Entity" and "Reference" for Multibanco
`value`	string	Contains the corresponding values to the headers of the payment instruction.

policy

A store policy, such as a privacy or return policy.

Fields	Type	Description
`body`	string	The content of the policy.
`id`	string	The ID of the policy.
`title`	string	The title of the policy.
`url`	string	The relative URL of the policy.

powered_by_link

A single value; it has no fields.

predictive_search

Information about the results from a predictive search query through the Predictive Search API.

Fields	Type	Description
`performed`	boolean	Returns `true` when being referenced inside a section that's been rendered using the Predictive Search API and the Section Rendering API. Returns `false` if not.
`resources`	predictive_search_resources	The resources associated with the query.
`terms`	string	The entered search terms.
`types`	array<string>	The object types that the search was performed on.

predictive_search_resources

Contains arrays of objects for each resource type that can be returned by a predictive search query.

Fields	Type	Description
`articles`	array<article>	The articles associated with the query.
`collections`	array<collection>	The collections associated with the query.
`pages`	array<page>	The pages associated with the query.
`products`	array<product>	The products associated with the query.

product

A product in the store.

Fields	Type	Description
`available`	boolean	Returns `true` if at least one of the variants of the product is available. Returns `false` if not.
`category`	taxonomy_category	The taxonomy category for the product
`collections`	array<collection>	The collections that the product belongs to.
`compare_at_price`	number	The lowest compare at price of any variants of the product in the currency's subunit.
`compare_at_price_max`	number	The highest compare at price of any variants of the product in the currency's subunit.
`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`.
`compare_at_price_varies`	boolean	Returns `true` if the variant compare at prices of the product vary. Returns `false` if not.
`content`	string	The description of the product.
`created_at`	string	A timestamp for when the product was created.
`description`	string	The description of the product.
`featured_image`	image	The first (featured) image attached to the product.
`featured_media`	media	The first (featured) media attached to the product.
`first_available_variant`	variant	The first available variant of the product.
`gift_card?`	boolean	Returns `true` if the product is a gift card. Returns `false` if not.
`handle`	string	The handle of the product.
`has_only_default_variant`	boolean	Returns `true` if the product doesn't have any options. Returns `false` if not.
`id`	number	The ID of the product.
`images`	array<image>	The images attached to the product.
`media`	array<media>	The media attached to the product, sorted by the date it was added to the product.
`metafields`	untyped	The metafields applied to the product.
`options`	array<string>	The option names of the product.
`options_by_name`	untyped	Allows you to access a specific product option by its name.
`options_with_values`	array<product_option>	The options on the product.
`price`	number	The lowest price of any variants of the product in the currency's subunit.
`price_max`	number	The highest price of any variants of the product in the currency's subunit.
`price_min`	number	The lowest price of any variants of the product in the currency's subunit.
`price_varies`	boolean	Returns `true` if the product's variant prices vary. Returns `false` if not.
`published_at`	string	A timestamp for when the product was published.
`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.
`requires_selling_plan`	boolean	Returns `true` if all of the variants of the product require a selling plan. Returns `false` if not.
`selected_or_first_available_selling_plan_allocation`	selling_plan_allocation	The currently selected, or first available, selling plan allocation.
`selected_or_first_available_variant`	variant	The currently selected or first available variant of the product.
`selected_selling_plan`	selling_plan	The currently selected selling plan.
`selected_selling_plan_allocation`	selling_plan_allocation	The currently selected selling plan allocation for the currently selected variant.
`selected_variant`	variant	The currently selected variant of the product.
`selling_plan_groups`	array<selling_plan_group>	The selling plan groups that the variants of the product are included in.
`tags`	array<string>	The tags of the product.
`template_suffix`	string	The name of the custom template of the product.
`title`	string	The title of the product.
`type`	string	The type of the product.
`url`	string	The relative URL of the product.
`variants`	array<variant>	The variants of the product.
`variants_count`	number	The total number of variants for the product.
`vendor`	string	The vendor of the product.

product_option

A product option, such as size or color.

Fields	Type	Description
`name`	string	The name of the product option.
`position`	number	The 1-based index of the product option in the `product.options_with_values` array.
`selected_value`	string	The currently selected product option value.
`values`	array<product_option_value>	The possible values for the product option.

product_option_value

A product option value, such as "red" for the option "color".

Fields	Type	Description
`available`	boolean	Whether or not the option value is available.
`id`	number	The ID of the product option value.
`name`	string	The name of the product option value.
`product_url`	string	Returns a URL if the option value may be associated with another product, nil otherwise.
`selected`	boolean	Whether or not the option value is selected.
`swatch`	swatch	Returns a swatch drop for the product option value. If there is no saved `color` or `image` content for the swatch, then the return value is `nil`.
`variant`	variant	The variant associated with this option value combined with the other currently selected option values, if one exists.

quantity_price_break

The per-unit price of a variant when purchasing the minimum quantity or more.

Fields	Type	Description
`minimum_quantity`	number	The minimum quantity required to qualify for the price break.
`price`	number	The price for the quantity price break once the minimum quantity is met.

quantity_rule

A variant order quantity rule.

Fields	Type	Description
`increment`	number	The number the order quantity can be incremented by. The default value is `1`.
`max`	number	The maximum order quantity.
`min`	number	The minimum order quantity. The default value is `1`.

rating

Information for a `rating` type metafield.

Fields	Type	Description
`rating`	number	The rating value.
`scale_max`	number	The maximum value of the rating scale.
`scale_min`	number	The minimum value of the rating scale.

recipient

A recipient that is associated with a gift card.

Fields	Type	Description
`email`	string	The email of the recipient.
`name`	string	The full name of the recipient.
`nickname`	string	The nickname of the recipient.

recommendations

Product recommendations for a specific product based on sales data, product descriptions, and collection relationships.

Fields	Type	Description
`intent`	string	The recommendation intent.
`performed?`	boolean	Returns `true` when being referenced inside a section that's been rendered using the Product Recommendations API and the Section Rendering API. Returns `false` if not.
`products`	array<product>	The recommended products.
`products_count`	number	The number of recommended products.

remote_details

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

Returns: RemoteDetailsDrop

Fields	Type	Description
`shop`	remote_shop	Information about the store that the remote object came from.
`type`	string	Provides context on how the remote object was surfaced. Currently the only supported value is "seller", but this may be expanded in the future.

remote_product

A product that comes from a remote source, inheriting all product functionality and also providing additional context about the remote source.

Returns: RemoteProductDrop

Fields	Type	Description
`available`	boolean	Returns `true` if at least one of the variants of the product is available. Returns `false` if not.
`category`	taxonomy_category	The taxonomy category for the product
`compare_at_price`	number	The lowest compare at price of any variants of the product in the currency's subunit.
`compare_at_price_max`	number	The highest compare at price of any variants of the product in the currency's subunit.
`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`.
`compare_at_price_varies`	boolean	Returns `true` if the variant compare at prices of the product vary. Returns `false` if not.
`content`	string	The description of the product.
`created_at`	string	A timestamp for when the product was created.
`description`	string	The description of the product.
`featured_image`	image	The first (featured) image attached to the product.
`featured_media`	media	The first (featured) media attached to the product.
`first_available_variant`	variant	The first available variant of the product.
`gift_card?`	boolean	Returns `true` if the product is a gift card. Returns `false` if not.
`has_only_default_variant`	boolean	Returns `true` if the product doesn't have any options. Returns `false` if not.
`id`	number	The ID of the product.
`images`	array<image>	The images attached to the product.
`media`	array<media>	The media attached to the product, sorted by the date it was added to the product.
`metafields`	untyped	The metafields applied to the product.
`options`	array<string>	The option names of the product.
`options_by_name`	untyped	Allows you to access a specific product option by its name.
`options_with_values`	array<product_option>	The options on the product.
`price`	number	The lowest price of any variants of the product in the currency's subunit.
`price_max`	number	The highest price of any variants of the product in the currency's subunit.
`price_min`	number	The lowest price of any variants of the product in the currency's subunit.
`price_varies`	boolean	Returns `true` if the product's variant prices vary. Returns `false` if not.
`published_at`	string	A timestamp for when the product was published.
`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.
`remote_details`	remote_details	Information about the remote source from which the remote product came from.
`requires_selling_plan`	boolean	Returns `true` if all of the variants of the product require a selling plan. Returns `false` if not.
`selected_or_first_available_selling_plan_allocation`	selling_plan_allocation	The currently selected, or first available, selling plan allocation.
`selected_or_first_available_variant`	variant	The currently selected or first available variant of the product.
`selected_selling_plan`	selling_plan	The currently selected selling plan.
`selected_selling_plan_allocation`	selling_plan_allocation	The currently selected selling plan allocation for the currently selected variant.
`selected_variant`	variant	The currently selected variant of the product.
`selling_plan_groups`	array<selling_plan_group>	The selling plan groups that the variants of the product are included in.
`template_suffix`	string	The name of the custom template assigned to the product.
`title`	string	The title of the product.
`type`	string	The type of the product.
`url`	string	The relative URL of the product.
`variants`	array<variant>	The variants of the product.
`variants_count`	number	The total number of variants for the product.
`vendor`	string	The vendor of the product.

remote_shop

Information about a remote store.

Returns: RemoteShopDrop

Fields	Type	Description
`brand`	brand	The brand assets for the remote store.
`name`	string	The name of the remote store.
`policies`	array<policy>	The shipping and refund policies for the remote store.
`refund_policy`	policy	The refund policy for the remote store.
`shipping_policy`	policy	The shipping policy for the remote store.

request

Information about the current URL and the associated page.

Fields	Type	Description
`design_mode`	boolean	Returns `true` if the request is being made from within the theme editor. Returns `false` if not.
`host`	string	The domain that the request is hosted on.
`locale`	shop_locale	The locale of the request.
`origin`	string	The protocol and host of the request.
`page_type`	string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string	The type of page being requested.
`path`	string	The path of the request.
`visual_preview_mode`	boolean	Returns `true` if the request is being made from within the theme editor's visual section preview. Returns `false` if not.

robots

The default rule groups for the `robots.txt` file.

Fields	Type	Description
`default_groups`	array<group>	The rule groups.

routes

Allows you to generate standard URLs for the storefront.

Fields	Type	Description
`account_addresses_url`	string	The account addresses page URL. Redirects to customer accounts when enabled.
`account_login_url`	string	The account login page URL. Redirects to customer accounts when enabled.
`account_logout_url`	string	The URL to log a customer out of their account. Redirects to customer accounts when enabled.
`account_profile_url`	string	The URL for the customer accounts profile page.
`account_recover_url`	string	The password recovery page URL. Redirects to customer accounts when enabled.
`account_register_url`	string	The account registration page URL.
`account_url`	string	The account page URL. Redirects to customer accounts when enabled.
`all_products_collection_url`	string	The all-products collection page URL.
`cart_add_url`	string	The URL for the `/cart/add` Cart API endpoint.
`cart_change_url`	string	The URL for the `/cart/change` Cart API endpoint.
`cart_clear_url`	string	The URL for the `/cart/clear` Cart API endpoint.
`cart_update_url`	string	The URL for the `/cart/update` Cart API endpoint.
`cart_url`	string	The cart page URL.
`collections_url`	string	The collection list page URL.
`predictive_search_url`	string	The Predictive Search API URL.
`product_recommendations_url`	string	The Product Recommendations API URL.
`root_url`	string	The index (home page) URL.
`search_url`	string	The search page URL.
`storefront_login_url`	string	Customer accounts login page. Redirects to the storefront page the customer was on before visiting the login page.

rule

A rule for the `robots.txt` file, which tells crawlers which pages can, or can't, be accessed.

Fields	Type	Description
`directive`	string	The directive of the rule.
`value`	string	The value of the rule.

search

Information about a storefront search query.

Fields	Type	Description
`default_sort_by`	string	The default sort order of the search results, which is `relevance`.
`filters`	array<filter>	The filters that have been set up on the search page.
`performed`	boolean	Returns `true` if a search was successfully performed. Returns `false` if not.
`results`	untyped	The search result items.
`results_count`	number	The number of results.
`sort_by`		The sort order of the search results. This is determined by the `sort_by` URL parameter.
`sort_options`	array<sort_option>	The available sorting options for the search results.
`terms`	string	The entered search terms.
`types`	array<string>	The object types that the search was performed on.

section

The properties and settings of a section.

Fields	Type	Description
`blocks`	array<block>	The blocks of the section.
`id`	string	The ID of the section.
`index`	number	The 1-based index of the current section within its location.
`index0`	number	The 0-based index of the current section within its location.
`location`	string	The scope or context of the section (template, section group, or global).
`settings`	untyped	The settings of the section.

self

The current Liquid scope.

Returns: untyped

A single value; it has no fields.

selling_plan

Information about the intent of how a specific selling plan affects a line item.

Fields	Type	Description
`checkout_charge`	selling_plan_checkout_charge	The checkout charge of the selling plan.
`description`	string	The description of the selling plan.
`group_id`	string	The ID of the `selling_plan_group` that the selling plan belongs to.
`id`	number	The ID of the selling plan.
`name`	string	The name of the selling plan.
`options`	array<selling_plan_option>	The selling plan options.
`price_adjustments`	array<selling_plan_price_adjustment>	The selling plan price adjustments.
`recurring_deliveries`	boolean	Returns `true` if the selling plan includes multiple deliveries. Returns `false` if not.
`selected`	boolean	Returns `true` if the selling plan is currently selected. Returns `false` if not.

selling_plan_allocation

Information about how a specific selling plan affects a line item.

Fields	Type	Description
`checkout_charge_amount`	number	The amount that the customer will be charged at checkout in the currency's subunit.
`compare_at_price`	number	The compare at price of the selling plan allocation in the currency's subunit.
`per_delivery_price`	number	The price for each delivery in the selling plan in the currency's subunit.
`price`	number	The price of the selling plan allocation in the currency's subunit.
`price_adjustments`	array<selling_plan_allocation_price_adjustment>	The selling plan allocation price adjustments.
`remaining_balance_charge_amount`	number	The remaining amount for the customer to pay, in the currency's subunit.
`selling_plan`	selling_plan	The selling plan that created the allocation.
`selling_plan_group_id`	string	The ID of the `selling_plan_group` that the selling plan of the allocation belongs to.
`unit_price`	number	The unit price of the variant associated with the selling plan, in the currency's subunit.

selling_plan_allocation_price_adjustment

The resulting price from the intent of the associated `selling_plan_price_adjustment`.

Fields	Type	Description
`position`	number	The 1-based index of the price adjustment in the `selling_plan_allocation.price_adjustments` array.
`price`	number	The price that will be charged for the price adjustment's lifetime, in the currency's subunit.

selling_plan_checkout_charge

Information about how a specific selling plan affects the amount that a customer needs to pay for a line item at checkout.

Fields	Type	Description
`value`	number	The value of the checkout charge.
`value_type`	string \| string	The value type of the checkout charge.

selling_plan_group

Information about a specific group of selling plans that include any of a product's variants.

Fields	Type	Description
`app_id`	string	An optional string provided by an app to identify selling plan groups created by that app.
`id`	number	The ID of the selling plan group.
`name`	string	The name of the selling plan group.
`options`	array<selling_plan_group_option>	The selling plan group options.
`selling_plan_selected`	boolean	Returns `true` if the currently selected selling plan is part of the selling plan group. Returns `false` if not.
`selling_plans`	array<selling_plan>	The selling plans in the group.

selling_plan_group_option

Information about a specific option in a selling plan group.

Fields	Type	Description
`name`	string	The name of the option.
`position`	number	The 1-based index of the option in the `selling_plan_group.options` array.
`selected_value`	string	The option value of the currently selected selling plan.
`values`	array<string>	The values of the option.

selling_plan_option

Information about a selling plan's value for a specific `selling_plan_group_option`.

Fields	Type	Description
`name`	string	The name of the associated `selling_plan_group_option`.
`position`	number	The 1-based index of the selling plan option in the associated `selling_plan_group.options` array.
`value`	string	The value of the selling plan option.

selling_plan_price_adjustment

Information about how a selling plan changes the price of a variant for a given period of time.

Fields	Type	Description
`order_count`	number	The number of orders that the price adjustment applies to.
`position`	number	The 1-based index of the price adjustment in the `selling_plan.price_adjustments` array.
`value`	number	The value of the price adjustment as a decimal.
`value_type`	string \| string \| string	The type of price adjustment.

settings

Allows you to access all of the theme's settings from the `settings_schema.json` file.

shipping_method

Information about the shipping method for an order.

Fields	Type	Description
`discount_allocations`	array<discount_allocation>	The discount allocations that apply to the shipping method.
`handle`	string	The handle of the shipping method.
`id`	string	The ID of the shipping method.
`original_price`	number	The price of the shipping method in the currency's subunit, before discounts have been applied.
`price`	number	The price of the shipping method in the currency's subunit, after discounts have been applied.
`price_with_discounts`	number	The price of the shipping method in the currency's subunit, after discounts have been applied, including order level discounts.
`tax_lines`	array<tax_line>	The tax lines for the shipping method.
`title`	string	The title of the shipping method.

shop

Information about the store, such as the store address, the total number of products, and various settings.

Fields	Type	Description
`accepts_gift_cards`	boolean	Returns `true` if the store accepts gift cards. Returns `false` if not.
`address`	address	The address of the store.
`brand`	brand	The brand assets for the store.
`collections_count`	number	The number of collections in the store.
`currency`	string	The currency of the store.
`customer_accounts_enabled`	boolean	Returns `true` if the store shows a login link. Returns `false` if not.
`customer_accounts_optional`	boolean	Returns `true` if customer accounts are optional to complete checkout. Returns `false` if not.
`description`	string	The description of the store.
`domain`	string	The primary domain of the store.
`email`	string	The sender email of the store.
`enabled_currencies`	array<currency>	The currencies that the store accepts.
`enabled_locales`	array<shop_locale> \| array<shop_locale>	The locales (languages) that are published on the store.
`enabled_payment_types`	array<string>	The accepted payment types on the store.
`id`	string	The ID of the store.
`locale`	shop_locale	The currently active locale (language).
`metafields`		The metafields applied to the store.
`metaobjects`		All of the metaobjects of the store.
`money_format`	currency	The money format of the store.
`money_with_currency_format`	currency	The money format of the store with the currency included.
`name`	string	The name of the store.
`password_message`	string	The password page message of the store.
`permanent_domain`	string
`phone`	string	The phone number of the store.
`policies`	array<policy>	The policies for the store.
`privacy_policy`	policy	The privacy policy for the store.
`products_count`	number	The number of products in the store.
`published_locales`	array<shop_locale>	The locales (languages) that are published on the store.
`refund_policy`	policy	The refund policy for the store.
`search_types`	array<string>	The resource types searched for by default when no `type` parameter is specified.
`secure_url`	string	The full URL of the store, with an `https` protocol.
`shipping_policy`	policy	The shipping policy for the store.
`subscription_policy`	policy	The subscription policy for the store.
`taxes_included`	boolean	Returns `true` if prices include taxes. Returns `false` if not.
`terms_of_service`	policy	The terms of service for the store.
`types`	array<string>	All of the product types in the store.
`url`	string	The full URL of the store.
`vendors`	array<string>	All of the product vendors for the store.

shop_locale

A language in a store.

Fields	Type	Description
`endonym_name`	string	The name of the locale in the locale itself.
`iso_code`	string	The ISO code of the locale in IETF language tag format.
`name`	string	The name of the locale in the store's primary locale.
`primary`	boolean	Returns `true` if the locale is the store's primary locale. Returns `false` if not.
`root_url`	string	The relative root URL of the locale.

sitemap

The sitemap for a specific group in the `robots.txt` file.

Fields	Type	Description
`directive`	string	Returns `Sitemap`.
`value`	string	The URL that the sitemap is hosted at.

sort_option

A sort option for a collection or search results page.

Fields	Type	Description
`name`	string	The customer-facing name of the sort option.
`value`	string	The value of the sort option.

store_availability

A variant's inventory information for a physical store location.

Fields	Type	Description
`available`	boolean	Returns `true` if the variant has available inventory at the location. Returns `false` if not.
`location`	location	The location that the variant is stocked at.
`pick_up_enabled`	boolean	Returns `true` if the location has pickup enabled. Returns `false` if not.
`pick_up_time`	string	The amount of time that it takes for pickup orders to be ready at the location.

store_credit_account

A store credit account owned by a customer.

Fields	Type	Description
`balance`	money	The balance of the store credit account in the currency's subunit.

swatch

Color and image for visual representation. Available for product option values and filter values.

Fields	Type	Description
`color`	color	The swatch color.
`image`	image	The swatch image.

tablerowloop

Information about a parent `tablerow` loop.

Fields	Type	Description
`col`	number	The 1-based index of the current column.
`col0`	number	The 0-based index of the current column.
`col_first`	boolean	Returns `true` if the current column is the first in the row. Returns `false` if not.
`col_last`	boolean	Returns `true` if the current column is the last in the row. Returns `false` if not.
`first`	boolean	Returns `true` if the current iteration is the first. Returns `false` if not.
`index`	number	The 1-based index of the current iteration.
`index0`	number	The 0-based index of the current iteration.
`last`	boolean	Returns `true` if the current iteration is the last. Returns `false` if not.
`length`	number	The total number of iterations in the loop.
`rindex`	number	The 1-based index of the current iteration, in reverse order.
`rindex0`	number	The 0-based index of the current iteration, in reverse order.
`row`	number	The 1-based index of current row.

tax_line

Information about a tax line of a checkout or order.

Fields	Type	Description
`price`	number	The tax amount in the currency's subunit.
`rate`	number	The decimal value of the tax rate.
`rate_percentage`	number	The decimal value of the tax rate, as a percentage.
`title`	string	The title of the tax.

taxonomy_category

The taxonomy category for a product

Fields	Type	Description
`ancestors`	array<taxonomy_category>	All parent nodes of the current taxonomy category.
`gid`	string
`id`	string	The public node ID for the category
`name`	string	The localized category name

template

Information about the current template.

Fields	Type	Description
`directory`	string	The name of the template's parent directory.
`name`	string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string \| string	The name of the template's type.
`suffix`	string	The custom name of an alternate template.

themeDeprecated

Information about the current theme.

Fields	Type	Description
`id`	number	The ID of the theme.
`name`	string	The name of the theme.
`role`	string \| string \| string \| string	The role of the theme.

transaction

A transaction associated with a checkout or order.

Fields	Type	Description
`amount`	number	The amount of the transaction in the currency's subunit.
`buyer_pending_payment_instructions`	array<pending_payment_instruction_input>
`buyer_pending_payment_notice`	string	A notice that contains instructions for the customer on how to complete their payment. The messages are specific to the payment method used.
`created_at`	string	A timestamp of when the transaction was created.
`gateway`	string	The handleized name of the payment provider used for the transaction.
`gateway_display_name`	string	The name of the payment provider used for the transaction.
`id`	number	The ID of the transaction.
`kind`	string \| string \| string \| string \| string	The type of transaction.
`name`	string	The name of the transaction.
`payment_details`	transaction_payment_details	The transaction payment details.
`receipt`	string	Information from the payment provider about the payment receipt.
`show_buyer_pending_payment_instructions?`	boolean	Whether the transaction is pending, and whether additional customer info is required to process the payment.
`status`	string \| string \| string \| string	The status of the transaction.
`status_label`	string	The status of the transaction, translated based on the current locale.

transaction_payment_details

Information about the payment methods used for a transaction.

Fields	Type	Description
`credit_card_company`	string	The name of the company that issued the credit card used for the transaction.
`credit_card_last_four_digits`	string	The last four digits of the credit card number of the credit card used for the transaction.
`credit_card_number`	string	The credit card number of the credit card used for the transaction.
`gift_card`	gift_card	The gift card used for the transaction.

unit_price_measurement

Information about how units of a product variant are measured. It's used to calculate unit prices.

Fields	Type	Description
`measured_type`	string \| string \| string \| string \| string	The type of unit measurement.
`quantity_unit`	string	The unit of measurement used to measure the `quantity_value`.
`quantity_value`	number	The quantity of the unit.
`reference_unit`	string	The unit of measurement used to measure the `reference_value`.
`reference_value`	number	The quantity of the unit for the base unit price.

user

The author of a blog article.

Fields	Type	Description
`account_owner`	boolean	Returns `true` if the author is the account owner of the store. Returns `false` if not.
`bio`	string	The bio associated with the author's account.
`email`	string	The email associated with the author's account.
`first_name`	string	The first name associated with the author's account.
`homepage`	string	The URL for the personal website associated with the author's account.
`image`	image	The image associated with the author's account.
`last_name`	string	The last name associated with the author's account.
`name`	string	The first and last name associated with the author's account.

user_agent

The user-agent, which is the name of the crawler, for a specific group in the `robots.txt` file.

Fields	Type	Description
`directive`	string	Returns `User-agent`.
`value`	string	The name of the user-agent.

variant

A product variant.

Fields	Type	Description
`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.
`featured_image`	image	The image attached to the variant.
`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.
`incoming`	boolean	Returns `true` if the variant has incoming inventory. Returns `false` if not.
`inventory_management`	string	The inventory management service of the variant.
`inventory_policy`	string \| string	Whether the variant should continue to be sold when it's out of stock.
`inventory_quantity`	number	The inventory quantity of the variant.
`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`	untyped	The metafields applied to the variant.
`next_incoming_date`	string	The arrival date for the next incoming inventory of the variant.
`option1`	string	The value of the variant for the first product option.
`option2`	string	The value of the variant for the second product option.
`option3`	string	The value of the variant for the third product option.
`options`	product_option_value	The values of the variant for each product option.
`price`	number	The price of the variant in the currency's subunit.
`product`	product	The parent product of the variant.
`quantity_price_breaks`	array<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.
`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.
`selected_selling_plan_allocation`	selling_plan_allocation	The selected `selling_plan_allocation`.
`selling_plan_allocations`	array<selling_plan_allocation>	The `selling_plan_allocation` objects for the variant.
`sku`	string	The SKU of the variant.
`store_availabilities`	array<store_availability>	The store availabilities for the 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 `/`.
`unit_price`	number	The unit price of the variant in the currency's subunit.
`unit_price_measurement`	unit_price_measurement	The unit price measurement of the variant.
`url`	string	The URL of the variant.
`weight`	number	The weight of the variant in grams.
`weight_in_unit`	number	The weight of the variant in the unit specified by `variant.weight_unit`.
`weight_unit`	string	The unit for the weight of the variant.

video

Information about a video uploaded as product media or a `file_reference` metafield.

Fields	Type	Description
`alt`	string	The alt text of the video.
`aspect_ratio`	number	The aspect ratio of the video as a decimal.
`duration`	number	The duration of the video in milliseconds.
`id`	number	The ID of the video.
`media_type`	string	The media type of the model. Always returns `video`.
`position`	number	The position of the video in the `product.media` array.
`preview_image`	image	A preview image for the video.
`sources`	array<video_source>	The source files for the video.

video_source

Information about the source files for a video.

Fields	Type	Description
`format`	string \| string \| string	The format of the video source file.
`height`	number	The height of the video source file.
`mime_type`	string	The MIME type of the video source file.
`url`	string	The CDN URL of the video source file.
`width`	number	The width of the video source file.