Products & Variants

Your product catalog in Commerce is represented by a pair of element types.

Products are the top-level container for goods and content.
Variants represent individual purchasables that are ultimately added to carts.

Every product must have one or more variants, and every variant belongs to a single product.

To illustrate the relationship between products and variants, consider the needs of a store that sells apparel.

A particular pair of tennis shoes is available in two colors, and in U.S. half-size increments from 6 to 12. The product we’re describing might have a name like “Court Balance DX,” while the variants represent each intersection of a color and size. This is both a key discovery tool (customers need to find shoes that fit their feet and style), and a necessary business tool for the store owner (tracking inventory, accounting for shipping weight, visualizing sales).

In this example, the product would hold all the marketing information like text, photos, and graphics, while the variants represent unique, saleable variations. Customers shop for a shoe that is aligned with their needs and tastes, but buy a specific size and color.

# Products

Products organize your goods into logical bundles of variants. A product itself is never actually purchased—what goes into a cart for purchase is one of the product’s variants. In this way, the product is free to house some globally-relevant attributes or content, while the variants describe specific physical or digital items.

In the same way that Craft’s native element types each share a set of common attributes, every Commerce product has a Title, Slug, Post Date, Expiry Date, and per-site status options.

# Product Types

Product Types provide a way to distinguish classes of goods in your stores. Manage product types in the control panel from

Commerce
System Settings
Product Types

Despite their similarities to entries, a product’s type cannot be changed after it is created.

# Product Type Options

Each product type has the following settings. Some product type settings govern the behavior of the variants nested within it!

Name

The name of the product type as displayed in the control panel. Customers only see this if you explicitly output it in the front-end (or in an email or PDF).

Handle

The handle is what you’ll use to reference the product type in code. In Twig, you would query for products with the clothes type like this:

{% set clothes = craft.products()
  .type('clothes')
  .all() %}

Versioning

Enable versioning to stage and revert product content changes with Craft’s drafts and revisions system. Provisional drafts (“autosaving,” colloquially) is always enabled.

Show the Title field for products

When enabled, each product will require a Title. Disable this if you’d like to generate titles with an object template, using values of other attributes or fields.

Title translation method 5.1.0+

When using custom titles, you can choose how titles are synchronized across sites that the product exists in. The options are identical to those available in custom fields.

For multi-store projects, you can use the Custom… option with a key format like this to synchronize titles across sites that use the same store:

{site.store.handle}

Product Title Format

If you are not using custom product titles, you must provide an object template so Commerce can generate one. Make sure your underlying data is distinct enough for customers and store managers to differentiate them!

Automatic SKU Format

Defines what variants’ auto-generated SKUs should look like when left empty. This setting is defined as an object template, meaning it can include dynamic values such as {product.slug} or {myCustomField}.

The SKU format is always evaluated in the context of a variant, so product attributes must be prefixed with product, like {product.myCustomField}.

Commerce requires that SKUs are unique across all variants in the system—including anything in the trash—so avoid using static or ambiguous values (like PLACEHOLDER) that are apt to collide when first saving a variant.

Order Description Format

Like the Automatic SKU Format, this is also an object template that is rendered in the context of a variant. It can include tags that output properties of the variant or its product, like {myVariantCustomField} or {product.title}.

The rendered string is ultimately stored in line items’ description attribute, and used to identify the purchasable in a customer’s cart (and the control panel). Changing a description format does not apply to completed orders, retroactively.

Max Variants

Limit the number of variants allowed by products of this type. Use 1 to enforce single-variant products, or leave blank to impose no limits.

Show the Dimensions and Weight fields

Allows you to hide the weight and dimensions fields if they are not necessary for variants belonging to products of this type.

Show the Title field for variants

Equivalent to Show the Title field for products, but for variants.

When enabled, you will select a Title Translation Method. To avoid confusion, this should generally match the product’s setting. 5.1.0+

When disabled, you must define a Variant Title Format using an object template. Note that this template is evaluated in the context of the variant, so product attributes and custom fields must be accessed as {product.slug} (not {slug} alone). The Title field layout element will always appear in the variant field layout designer, but it will be hidden when editing a variant.

Site Settings

Like entries and other built-in element types, products provide site-specific routing settings. When a customer visits a product’s URL in a given site, Commerce renders the specified template with a special product variable.

Variants do not have their own routing mechanism; calling variant.url will return the product’s URL (for the site it was loaded in) with a variant={id} query string appended.

Propagation Method 5.1.0+

Choose how new product and variant elements are propagated across its supported sites.

When you create a new product type, don’t forget to give your store managers the appropriate permissions!

# Tax & Shipping

The second tab in a product type’s settings screen is strictly informational—it displays a list of Shipping Categories and Tax Categories (from the Store Management area) that can be selected from variants of current product type.

Product types are defined globally, but shipping and tax categories are defined per-store. If you have similarly-named categories in multiple stores, you may see them listed twice.

# Product Fields

Every product type’s authoring experience can be tailored to its needs through a field layout. Consider what content belongs on a product and what belongs on a variant.

A product’s field layout must include the special Variants field layout element, which controls where the nested element management interface lives.

# Variant Fields

In addition to fields associated with a product, the product type defines what fields are available to its nested variants.

# Templating

There are a ton of ways to leverage your product types and product data in templates. Keep in mind that the custom fields available to each product type may differ—but they’re accessed exactly the same way as you would with any other element type!

# Displaying a Product Type

Every product has access to its product type definition via a type attribute:

<ul class="breadcrumbs">
  <li><a href="{{ siteUrl }}">Home</a></li>
  <li><a href="{{ siteUrl('shop') }}">Shop</a></li>
  <li><a href="{{ siteUrl("shop/#{product.type.handle}") }}">{{ product.type.name }}</a></li>
</ul>

<h2>{{ product.title }}</h2>

This example generates a URL to an “index” for a product type—but requires that we set up a corresponding route that maps it to a template:

return [
    // ...
    'shop/<productType:{slug}>' => ['template' => '_shop/product-type'],
];

An equivalent route can by configured in the control panel, via

Settings
Routes

Configuring a route to a product type index in the Craft control panel

# Listing Product Types

You can access a list of all configured product types via Commerce’s productTypes service:

{% for type in craft.commerce.productTypes.allProductTypes %}
  {{ type.handle }} - {{ type.name }}
{% endfor %}

# Querying Products

Products are automatically loaded and exposed under a product variable when their URL is requested. In situations where you need to fetch one or more products based on some fixed or dynamic criteria, you will use a product query.

Product queries are a kind of element query, meaning they have a similar API to Craft’s built-in element types:

Twig
PHP
GraphQL

{# Create a new product query #}
{% set myProductQuery = craft.products() %}

Once you’ve created a product query, you can set parameters on it to narrow down the results, and then execute it to return one or more Product (opens new window) elements.

See Element Queries in the Craft docs to learn about how element queries work.

# Example

We can use Twig to display the ten most recently-added Clothing products:

Create a product query with craft.products().
Set the type and limit parameters on it.
Fetch the products with .all().
Loop through the products using a for (opens new window) tag to output their HTML.

{# Create a product query with the 'type' and 'limit' parameters #}
{% set newProducts = craft.products()
  .type('clothing')
  .limit(10)
  .all() %}

{# Display the products #}
{% for product in newProducts %}
  <h2>{{ product.title }}</h2>
  {{ product.summary|md }}
  <a href="{{ product.url }}">Learn more</a>
{% endfor %}

To fetch the same information with Craft’s GraphQL API, we could write a query like this:

{
  products(limit: 10, type: "clothing") {
    title
    uri
    ... on clothing_Product {
      summary
    }
  }
}

# Eager-loading

Products can be eager-loaded using the handle of a relational field attached to other elements, and you can eager-load other related elements just as you would with any other element query.

You can also eager-load variants (and any elements related to or nested within them) via their products using the special variants handle:

{% set products = craft.products()
  .type('widgets')
  .with([
    ['variants.complianceStandards'],
  ])
  .all() %}

<ul>
  {% for product in products %}
    <li>
      <strong>{{ product.title }}</strong>
      <span class="separator">—</span>
      Options meeting:
      {{ product.variants|map(v => v.complianceStandards)|flatten|join(', ') }}
    </li>
  {% endfor %}
</ul>

# Product Query Parameters

Product queries support the following parameters:

Param	Description
after	Narrows the query results to only products that were posted on or after a certain date.
afterPopulate	Performs any post-population processing on elements.
andRelatedTo	Narrows the query results to only products that are related to certain other elements.
asArray	Causes the query to return matching products as arrays of data, rather than Product (opens new window) objects.
before	Narrows the query results to only products that were posted before a certain date.
cache	Enables query cache for this Query.
clearCachedResult	Clears the cached result (opens new window).
dateCreated	Narrows the query results based on the products’ creation dates.
dateUpdated	Narrows the query results based on the products’ last-updated dates.
defaultHeight	Narrows the query results based on the products’ default variant height dimension IDs.
defaultLength	Narrows the query results based on the products’ default variant length dimension IDs.
defaultPrice	Narrows the query results based on the products’ default variant price.
defaultSku	Narrows the query results based on the default productvariants defaultSku
defaultWeight	Narrows the query results based on the products’ default variant weight dimension IDs.
defaultWidth	Narrows the query results based on the products’ default variant width dimension IDs.
eagerly	Causes the query to be used to eager-load results for the query’s source element and any other elements in its collection.
expiryDate	Narrows the query results based on the products’ expiry dates.
fixedOrder	Causes the query results to be returned in the order specified by id.
hasVariant	Narrows the query results to only products that have certain variants.
id	Narrows the query results based on the products’ IDs.
ignorePlaceholders	Causes the query to return matching products as they are stored in the database, ignoring matching placeholder elements that were set by craft\services\Elements::setPlaceholderElement() (opens new window).
inBulkOp	Narrows the query results to only products that were involved in a bulk element operation.
inReverse	Causes the query results to be returned in reverse order.
language	Determines which site(s) the products should be queried in, based on their language.
limit	Determines the number of products that should be returned.
offset	Determines how many products should be skipped in the results.
orderBy	Determines the order that the products should be returned in. (If empty, defaults to `postDate DESC`.)
postDate	Narrows the query results based on the products’ post dates.
preferSites	If unique is set, this determines which site should be selected when querying multi-site elements.
prepForEagerLoading	Prepares the query for lazy eager loading.
prepareSubquery	Prepares the element query and returns its subquery (which determines what elements will be returned).
relatedTo	Narrows the query results to only products that are related to certain other elements.
render	Executes the query and renders the resulting elements using their partial templates.
search	Narrows the query results to only products that match a search query.
site	Determines which site(s) the products should be queried in.
siteId	Determines which site(s) the products should be queried in, per the site’s ID.
siteSettingsId	Narrows the query results based on the products’ IDs in the `elements_sites` table.
slug	Narrows the query results based on the products’ slugs.
status	Narrows the query results based on the products’ statuses.
title	Narrows the query results based on the products’ titles.
trashed	Narrows the query results to only products that have been soft-deleted.
type	Narrows the query results based on the products’ types.
typeId	Narrows the query results based on the products’ types, per the types’ IDs.
uid	Narrows the query results based on the products’ UIDs.
unique	Determines whether only elements with unique IDs should be returned by the query.
uri	Narrows the query results based on the products’ URIs.
wasCountEagerLoaded	Returns whether the query result count was already eager loaded by the query's source element.
wasEagerLoaded	Returns whether the query results were already eager loaded by the query's source element.
with	Causes the query to return matching products eager-loaded with related elements.
withCustomFields	Sets whether custom fields should be factored into the query.

# `after`

Narrows the query results to only products that were posted on or after a certain date.

Possible values include:

Value	Fetches products…
`'2018-04-01'`	that were posted after 2018-04-01.
a DateTime (opens new window) object	that were posted after the date represented by the object.

Twig
PHP

{# Fetch products posted this month #}
{% set firstDayOfMonth = date('first day of this month') %}

{% set products = craft.products()
  .after(firstDayOfMonth)
  .all() %}

# `afterPopulate`

Performs any post-population processing on elements.

# `andRelatedTo`

Narrows the query results to only products that are related to certain other elements.

See Relations (opens new window) for a full explanation of how to work with this parameter.

Twig
PHP

{# Fetch all products that are related to myCategoryA and myCategoryB #}
{% set products = craft.products()
  .relatedTo(myCategoryA)
  .andRelatedTo(myCategoryB)
  .all() %}

# `asArray`

Causes the query to return matching products as arrays of data, rather than Product (opens new window) objects.

Twig
PHP

{# Fetch products as arrays #}
{% set products = craft.products()
  .asArray()
  .all() %}

# `before`

Narrows the query results to only products that were posted before a certain date.

Possible values include:

Value	Fetches products…
`'2018-04-01'`	that were posted before 2018-04-01.
a DateTime (opens new window) object	that were posted before the date represented by the object.

Twig
PHP

{# Fetch products posted before this month #}
{% set firstDayOfMonth = date('first day of this month') %}

{% set products = craft.products()
  .before(firstDayOfMonth)
  .all() %}

# `cache`

Enables query cache for this Query.

# `clearCachedResult`

Clears the cached result (opens new window).

# `dateCreated`

Narrows the query results based on the products’ creation dates.

Possible values include:

Value	Fetches products…
`'>= 2018-04-01'`	that were created on or after 2018-04-01.
`'< 2018-05-01'`	that were created before 2018-05-01.
`['and', '>= 2018-04-04', '< 2018-05-01']`	that were created between 2018-04-01 and 2018-05-01.
`now`/`today`/`tomorrow`/`yesterday`	that were created at midnight of the specified relative date.

Twig
PHP

{# Fetch products created last month #}
{% set start = date('first day of last month')|atom %}
{% set end = date('first day of this month')|atom %}

{% set products = craft.products()
  .dateCreated(['and', ">= #{start}", "< #{end}"])
  .all() %}

# `dateUpdated`

Narrows the query results based on the products’ last-updated dates.

Possible values include:

Value	Fetches products…
`'>= 2018-04-01'`	that were updated on or after 2018-04-01.
`'< 2018-05-01'`	that were updated before 2018-05-01.
`['and', '>= 2018-04-04', '< 2018-05-01']`	that were updated between 2018-04-01 and 2018-05-01.
`now`/`today`/`tomorrow`/`yesterday`	that were updated at midnight of the specified relative date.

Twig
PHP

{# Fetch products updated in the last week #}
{% set lastWeek = date('1 week ago')|atom %}

{% set products = craft.products()
  .dateUpdated(">= #{lastWeek}")
  .all() %}

# `defaultHeight`

Narrows the query results based on the products’ default variant height dimension IDs.

Possible values include:

Value	Fetches products…
`1`	of a type with a dimension of 1.
`'not 1'`	not a dimension of 1.
`[1, 2]`	of a a dimension 1 or 2.
`['and', '>= ' ~ 100, '<= ' ~ 2000]`	of a dimension between 100 and 2000

Twig
PHP

{# Fetch products of the product default dimension of 1 #}
{% set products = craft.products()
  .defaultHeight(1)
  .all() %}

# `defaultLength`

Narrows the query results based on the products’ default variant length dimension IDs.

Possible values include:

Value	Fetches products…
`1`	of a type with a dimension of 1.
`'not 1'`	not a dimension of 1.
`[1, 2]`	of a a dimension 1 or 2.
`['and', '>= ' ~ 100, '<= ' ~ 2000]`	of a dimension between 100 and 2000

Twig
PHP

{# Fetch products of the product default dimension of 1 #}
{% set products = craft.products()
  .defaultLength(1)
  .all() %}

# `defaultPrice`

Narrows the query results based on the products’ default variant price.

Possible values include:

Value	Fetches products…
`10`	of a price of 10.
`['and', '>= ' ~ 100, '<= ' ~ 2000]`	of a default variant price between 100 and 2000

Twig
PHP

{# Fetch products of the product type with an ID of 1 #}
{% set products = craft.products()
  .defaultPrice(1)
  .all() %}

# `defaultSku`

Narrows the query results based on the default productvariants defaultSku

Possible values include:

Value	Fetches products…
`xxx-001`	of products default SKU of `xxx-001`.
`'not xxx-001'`	not a default SKU of `xxx-001`.
`['not xxx-001', 'not xxx-002']`	of a default SKU of xxx-001 or xxx-002.
`['not',`xxx-001`,`xxx-002`]`	not a product default SKU of `xxx-001` or `xxx-001`.

Twig
PHP

{# Fetch products of the product default SKU of `xxx-001` #}
{% set products = craft.products()
  .defaultSku('xxx-001')
  .all() %}

# `defaultWeight`

Narrows the query results based on the products’ default variant weight dimension IDs.

Possible values include:

Value	Fetches products…
`1`	of a type with a dimension of 1.
`'not 1'`	not a dimension of 1.
`[1, 2]`	of a a dimension 1 or 2.
`['and', '>= ' ~ 100, '<= ' ~ 2000]`	of a dimension between 100 and 2000

Twig
PHP

{# Fetch products of the product default dimension of 1 #}
{% set products = craft.products()
  .defaultWeight(1)
  .all() %}

# `defaultWidth`

Narrows the query results based on the products’ default variant width dimension IDs.

Possible values include:

Value	Fetches products…
`1`	of a type with a dimension of 1.
`'not 1'`	not a dimension of 1.
`[1, 2]`	of a a dimension 1 or 2.
`['and', '>= ' ~ 100, '<= ' ~ 2000]`	of a dimension between 100 and 2000

Twig
PHP

{# Fetch products of the product default dimension of 1 #}
{% set products = craft.products()
  .defaultWidth(1)
  .all() %}

# `eagerly`

Causes the query to be used to eager-load results for the query’s source element and any other elements in its collection.

# `expiryDate`

Narrows the query results based on the products’ expiry dates.

Possible values include:

Value	Fetches products…
`'>= 2020-04-01'`	that will expire on or after 2020-04-01.
`'< 2020-05-01'`	that will expire before 2020-05-01
`['and', '>= 2020-04-04', '< 2020-05-01']`	that will expire between 2020-04-01 and 2020-05-01.

Twig
PHP

{# Fetch products expiring this month #}
{% set nextMonth = date('first day of next month')|atom %}

{% set products = craft.products()
  .expiryDate("< #{nextMonth}")
  .all() %}

# `fixedOrder`

Causes the query results to be returned in the order specified by id.

If no IDs were passed to id, setting this to true will result in an empty result set.

Twig
PHP

{# Fetch products in a specific order #}
{% set products = craft.products()
  .id([1, 2, 3, 4, 5])
  .fixedOrder()
  .all() %}

# `hasVariant`

Narrows the query results to only products that have certain variants.

Possible values include:

Value	Fetches products…
a VariantQuery (opens new window) object	with variants that match the query.

# `id`

Narrows the query results based on the products’ IDs.

Possible values include:

Value	Fetches products…
`1`	with an ID of 1.
`'not 1'`	not with an ID of 1.
`[1, 2]`	with an ID of 1 or 2.
`['not', 1, 2]`	not with an ID of 1 or 2.

Twig
PHP

{# Fetch the product by its ID #}
{% set product = craft.products()
  .id(1)
  .one() %}

This can be combined with fixedOrder if you want the results to be returned in a specific order.

# `ignorePlaceholders`

Causes the query to return matching products as they are stored in the database, ignoring matching placeholder elements that were set by craft\services\Elements::setPlaceholderElement() (opens new window).

# `inBulkOp`

Narrows the query results to only products that were involved in a bulk element operation.

# `inReverse`

Causes the query results to be returned in reverse order.

Twig
PHP

{# Fetch products in reverse #}
{% set products = craft.products()
  .inReverse()
  .all() %}

# `language`

Determines which site(s) the products should be queried in, based on their language.

Possible values include:

Value	Fetches products…
`'en'`	from sites with a language of `en`.
`['en-GB', 'en-US']`	from sites with a language of `en-GB` or `en-US`.
`['not', 'en-GB', 'en-US']`	not in sites with a language of `en-GB` or `en-US`.

Elements that belong to multiple sites will be returned multiple times by default. If you only want unique elements to be returned, use unique in conjunction with this.

Twig
PHP

{# Fetch products from English sites #}
{% set products = craft.products()
  .language('en')
  .all() %}

# `limit`

Determines the number of products that should be returned.

Twig
PHP

{# Fetch up to 10 products  #}
{% set products = craft.products()
  .limit(10)
  .all() %}

# `offset`

Determines how many products should be skipped in the results.

Twig
PHP

{# Fetch all products except for the first 3 #}
{% set products = craft.products()
  .offset(3)
  .all() %}

# `orderBy`

Determines the order that the products should be returned in. (If empty, defaults to postDate DESC.)

Twig
PHP

{# Fetch all products in order of date created #}
{% set products = craft.products()
  .orderBy('dateCreated ASC')
  .all() %}

# `postDate`

Narrows the query results based on the products’ post dates.

Possible values include:

Value	Fetches products…
`'>= 2018-04-01'`	that were posted on or after 2018-04-01.
`'< 2018-05-01'`	that were posted before 2018-05-01
`['and', '>= 2018-04-04', '< 2018-05-01']`	that were posted between 2018-04-01 and 2018-05-01.

Twig
PHP

{# Fetch products posted last month #}
{% set start = date('first day of last month')|atom %}
{% set end = date('first day of this month')|atom %}

{% set products = craft.products()
  .postDate(['and', ">= #{start}", "< #{end}"])
  .all() %}

# `preferSites`

If unique is set, this determines which site should be selected when querying multi-site elements.

For example, if element “Foo” exists in Site A and Site B, and element “Bar” exists in Site B and Site C, and this is set to ['c', 'b', 'a'], then Foo will be returned for Site B, and Bar will be returned for Site C.

If this isn’t set, then preference goes to the current site.

Twig
PHP

{# Fetch unique products from Site A, or Site B if they don’t exist in Site A #}
{% set products = craft.products()
  .site('*')
  .unique()
  .preferSites(['a', 'b'])
  .all() %}

# `prepForEagerLoading`

Prepares the query for lazy eager loading.

# `prepareSubquery`

Prepares the element query and returns its subquery (which determines what elements will be returned).

# `relatedTo`

Narrows the query results to only products that are related to certain other elements.

See Relations (opens new window) for a full explanation of how to work with this parameter.

Twig
PHP

{# Fetch all products that are related to myCategory #}
{% set products = craft.products()
  .relatedTo(myCategory)
  .all() %}

# `render`

Executes the query and renders the resulting elements using their partial templates.

If no partial template exists for an element, its string representation will be output instead.

# `search`

Narrows the query results to only products that match a search query.

See Searching (opens new window) for a full explanation of how to work with this parameter.

Twig
PHP

{# Get the search query from the 'q' query string param #}
{% set searchQuery = craft.app.request.getQueryParam('q') %}

{# Fetch all products that match the search query #}
{% set products = craft.products()
  .search(searchQuery)
  .all() %}

# `site`

Determines which site(s) the products should be queried in.

The current site will be used by default.

Possible values include:

Value	Fetches products…
`'foo'`	from the site with a handle of `foo`.
`['foo', 'bar']`	from a site with a handle of `foo` or `bar`.
`['not', 'foo', 'bar']`	not in a site with a handle of `foo` or `bar`.
a craft\models\Site (opens new window) object	from the site represented by the object.
`'*'`	from any site.

If multiple sites are specified, elements that belong to multiple sites will be returned multiple times. If you only want unique elements to be returned, use unique in conjunction with this.

Twig
PHP

{# Fetch products from the Foo site #}
{% set products = craft.products()
  .site('foo')
  .all() %}

# `siteId`

Determines which site(s) the products should be queried in, per the site’s ID.

The current site will be used by default.

Possible values include:

Value	Fetches products…
`1`	from the site with an ID of `1`.
`[1, 2]`	from a site with an ID of `1` or `2`.
`['not', 1, 2]`	not in a site with an ID of `1` or `2`.
`'*'`	from any site.

Twig
PHP

{# Fetch products from the site with an ID of 1 #}
{% set products = craft.products()
  .siteId(1)
  .all() %}

# `siteSettingsId`

Narrows the query results based on the products’ IDs in the elements_sites table.

Possible values include:

Value	Fetches products…
`1`	with an `elements_sites` ID of 1.
`'not 1'`	not with an `elements_sites` ID of 1.
`[1, 2]`	with an `elements_sites` ID of 1 or 2.
`['not', 1, 2]`	not with an `elements_sites` ID of 1 or 2.

Twig
PHP

{# Fetch the product by its ID in the elements_sites table #}
{% set product = craft.products()
  .siteSettingsId(1)
  .one() %}

# `slug`

Narrows the query results based on the products’ slugs.

Possible values include:

Value	Fetches products…
`'foo'`	with a slug of `foo`.
`'foo*'`	with a slug that begins with `foo`.
`'*foo'`	with a slug that ends with `foo`.
`'foo'`	with a slug that contains `foo`.
`'not foo'`	with a slug that doesn’t contain `foo`.
`['foo', 'bar']`	with a slug that contains `foo` or `bar`.
`['not', 'foo', 'bar']`	with a slug that doesn’t contain `foo` or `bar`.

Twig
PHP

{# Get the requested product slug from the URL #}
{% set requestedSlug = craft.app.request.getSegment(3) %}

{# Fetch the product with that slug #}
{% set product = craft.products()
  .slug(requestedSlug|literal)
  .one() %}

# `status`

Narrows the query results based on the products’ statuses.

Possible values include:

Value	Fetches products…
`'live'` (default)	that are live.
`'pending'`	that are pending (enabled with a Post Date in the future).
`'expired'`	that are expired (enabled with an Expiry Date in the past).
`'disabled'`	that are disabled.
`['live', 'pending']`	that are live or pending.

Twig
PHP

{# Fetch disabled products #}
{% set products = craft.products()
  .status('disabled')
  .all() %}

# `title`

Narrows the query results based on the products’ titles.

Possible values include:

Value	Fetches products…
`'Foo'`	with a title of `Foo`.
`'Foo*'`	with a title that begins with `Foo`.
`'*Foo'`	with a title that ends with `Foo`.
`'Foo'`	with a title that contains `Foo`.
`'not Foo'`	with a title that doesn’t contain `Foo`.
`['Foo', 'Bar']`	with a title that contains `Foo` or `Bar`.
`['not', 'Foo', 'Bar']`	with a title that doesn’t contain `Foo` or `Bar`.

Twig
PHP

{# Fetch products with a title that contains "Foo" #}
{% set products = craft.products()
  .title('*Foo*')
  .all() %}

# `trashed`

Narrows the query results to only products that have been soft-deleted.

Twig
PHP

{# Fetch trashed products #}
{% set products = craft.products()
  .trashed()
  .all() %}

# `type`

Narrows the query results based on the products’ types.

Possible values include:

Value	Fetches products…
`'foo'`	of a type with a handle of `foo`.
`'not foo'`	not of a type with a handle of `foo`.
`['foo', 'bar']`	of a type with a handle of `foo` or `bar`.
`['not', 'foo', 'bar']`	not of a type with a handle of `foo` or `bar`.
an ProductType (opens new window) object	of a type represented by the object.

Twig
PHP

{# Fetch products with a Foo product type #}
{% set products = craft.products()
  .type('foo')
  .all() %}

# `typeId`

Narrows the query results based on the products’ types, per the types’ IDs.

Possible values include:

Value	Fetches products…
`1`	of a type with an ID of 1.
`'not 1'`	not of a type with an ID of 1.
`[1, 2]`	of a type with an ID of 1 or 2.
`['not', 1, 2]`	not of a type with an ID of 1 or 2.

Twig
PHP

{# Fetch products of the product type with an ID of 1 #}
{% set products = craft.products()
  .typeId(1)
  .all() %}

# `uid`

Narrows the query results based on the products’ UIDs.

Twig
PHP

{# Fetch the product by its UID #}
{% set product = craft.products()
  .uid('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')
  .one() %}

# `unique`

Determines whether only elements with unique IDs should be returned by the query.

This should be used when querying elements from multiple sites at the same time, if “duplicate” results is not desired.

Twig
PHP

{# Fetch unique products across all sites #}
{% set products = craft.products()
  .site('*')
  .unique()
  .all() %}

# `uri`

Narrows the query results based on the products’ URIs.

Possible values include:

Value	Fetches products…
`'foo'`	with a URI of `foo`.
`'foo*'`	with a URI that begins with `foo`.
`'*foo'`	with a URI that ends with `foo`.
`'foo'`	with a URI that contains `foo`.
`'not foo'`	with a URI that doesn’t contain `foo`.
`['foo', 'bar']`	with a URI that contains `foo` or `bar`.
`['not', 'foo', 'bar']`	with a URI that doesn’t contain `foo` or `bar`.

Twig
PHP

{# Get the requested URI #}
{% set requestedUri = craft.app.request.getPathInfo() %}

{# Fetch the product with that URI #}
{% set product = craft.products()
  .uri(requestedUri|literal)
  .one() %}

# `wasCountEagerLoaded`

Returns whether the query result count was already eager loaded by the query's source element.

# `wasEagerLoaded`

Returns whether the query results were already eager loaded by the query's source element.

# `with`

Causes the query to return matching products eager-loaded with related elements.

See Eager-Loading Elements (opens new window) for a full explanation of how to work with this parameter.

Twig
PHP

{# Fetch products eager-loaded with the "Related" field’s relations #}
{% set products = craft.products()
  .with(['related'])
  .all() %}

# `withCustomFields`

Sets whether custom fields should be factored into the query.

# Variants

Variants are purchasables, and they represent the individual items that customers will add to their carts as line items—even when a product only has a single variant. The variant is where you’ll control pricing information, tax and shipping settings, inventory, dimensions, and so on.

Commerce gives you a great deal of flexibility in designing your product catalog—but an important consideration early-on is how you want customers to discover goods in your store. Setting aside for a moment single-variant products, variants don’t get their own URLs, and are queried separately from products. Prematurely grouping items into products can make selection difficult for customers, while aggressively separating variations of a single item into products can make differentiating products more difficult for customers.

Consider these tradeoffs when building your catalog—and don’t forget that all of Craft’s content and relational tools are at your disposal, on both products and variants!

# Prices

Every variant has a price and a promotional price. Both base prices are defined directly on the variant, in a store’s default currency—but the final price shown to a customer may be determined by pricing rules and currency conversion.

Prices are defined for each store a variant is available in; in the control panel, however, you will manage those differences on a per-site basis. If two sites point to the same store, you will see the same price and input currency when editing the variant in either.

# Promotional Price

When provided, a promotional price takes precedence over the base price in all calculations. This is also the case after Commerce evaluates pricing rules, but only when the promotional price ends up less than the base price.

In a template, you can test whether a product has a promotional price (and it is less than its base price):

{% for variant in product.variants %}
  <label class="option">
    <input name="purchasableId" value="{{ variant.id }}" type="radio">
    <span class="label">{{ purchasable.title }}</label>
    <span class="price {{ variant.onPromotion ? 'price--has-promo' : null }}">
      <span class="price__base">{{ variant.price|commerceCurrency }}</span>

      {% if variant.onPromotion %}
        <span class="price__promotional">{{ variant.promotionalPrice|commerceCurrency }}</span>
      {% endif %}
    </span>
  </label>
{% endfor %}

# Sale Price

If you only want to advertise a single price, let Commerce reconcile the base and promotional price by using variant.salePrice.

# Stock

Commerce tracks inventory at the variant level, using Inventory Items that correspond to each unique SKU in the system.

Inventory

Manage stock and fulfill orders with sophisticated inventory tools.

Variants may define a minimum and maximum quantity that customers are allowed to add to their cart.

Minimum and maximum quantities are static. If you need to enforce dynamic quantity limits, advanced validation rules can be added to line items via a plugin or module.

# Physical Properties

If the product type is configured to display dimension fields, each variant can include a Length, Width, and Height, as well as a Weight.

Dimensions and weight are set in the system’s Dimensions Unit and Weight Unit, respectively.

Changing the dimension or weight unit after products have been created will not convert existing values!

# SKUs

Each variant has a globally-unique SKU. SKUs can be defined manually, or through a dynamically-evaluated SKU format (defined by its product’s type).

Commerce tracks a single inventory item per SKU, but that SKU may have inventory at multiple locations.

# Tax & Shipping Categories

When creating a variant, you will select its Tax and Shipping Category.

For a Tax Category to be selectable, it must be allowed for the product type that the variant belongs to. This is a setting on the tax category itself; tax categories are shared across stores, but the effective zones and rates are defined per-store. Variants use the same tax category in all stores.

The Shipping Category follows similar rules, but the options are defined per-store.

Each variant may also have any number of custom fields to allow other distinguishing traits.

Commerce does not automatically create every possible unique variant for you—that’s up to the store manager.

# Default Variant

Every product has a default variant. The default variant is indicated by a green check-mark in the nested element index.

To change the default variant, select its row in the element index and use the Set default variant element action.

# Querying Variants

The most common ways to access variants will be via their product or from a line item in a customer’s cart or order. In cases where you need to directly load one or more variants, you will use a variant query.

Variant queries are a special type of element query, and are created and executed using the same fluent API:

Twig
PHP
GraphQL

{# Create a new variant query #}
{% set myVariantQuery = craft.variants() %}

Once you’ve created a variant query, you can set parameters on it to narrow down the results, and then execute it by calling .all(). An array of Variant (opens new window) objects will be returned.

You can also fetch only the number of items a query might return, which is better for performance when you don’t need the variant data.

Twig
PHP
GraphQL

{# Count all enabled variants #}
{% set myVariantCount = craft.variants()
    .status('enabled')
    .count() %}

See Element Queries in the Craft docs to learn about how element queries work.

# Example

We can display a specific variant by its SKU in Twig by doing the following:

Create a variant query with craft.variants().
Set the sku parameter on it.
Fetch the variant with .one().
Output information about the variant as HTML.

{# Get the requested variant SKU from the query string #}
{% set variantSku = craft.app.request.getQueryParam('sku') %}

{# Create a variant query with the 'SKU' parameter #}
{% set myVariantQuery = craft.variants()
    .sku(variantSku) %}

{# Fetch the variant #}
{% set variant = myVariantQuery.one() %}

{# Make sure it exists #}
{% if not variant %}
    {% exit 404 %}
{% endif %}

{# Display information about the variant #}
<h1>{{ variant.title }}</h1>
<!-- ... -->

Fetching the equivalent with GraphQL could look like this:

# Fetch variant with a SKU of `WIDGET-BASIC`
{
  variants(sku: 'WIDGET-BASIC') {
    title
  }
}

# Variant Query Parameters

Variant queries support the following parameters:

Param	Description
afterPopulate	Performs any post-population processing on elements.
andRelatedTo	Narrows the query results to only variants that are related to certain other elements.
asArray	Causes the query to return matching variants as arrays of data, rather than Variant (opens new window) objects.
cache	Enables query cache for this Query.
clearCachedResult	Clears the cached result (opens new window).
dateCreated	Narrows the query results based on the variants’ creation dates.
dateUpdated	Narrows the query results based on the variants’ last-updated dates.
fixedOrder	Causes the query results to be returned in the order specified by id.
hasProduct	Narrows the query results to only variants for certain products.
hasSales	Narrows the query results to only variants that are on sale.
hasStock	Narrows the query results to only variants that have stock.
hasUnlimitedStock	Narrows the query results to only variants that have been set to unlimited stock.
height	Narrows the query results based on the variants’ height dimension.
id	Narrows the query results based on the variants’ IDs.
ignorePlaceholders	Causes the query to return matching variants as they are stored in the database, ignoring matching placeholder elements that were set by craft\services\Elements::setPlaceholderElement() (opens new window).
inReverse	Causes the query results to be returned in reverse order.
isDefault	Narrows the query results to only default variants.
length	Narrows the query results based on the variants’ length dimension.
limit	Determines the number of variants that should be returned.
maxQty	Narrows the query results based on the variants’ max quantity.
minQty	Narrows the query results based on the variants’ min quantity.
offset	Determines how many variants should be skipped in the results.
orderBy	Determines the order that the variants should be returned in. (If empty, defaults to `sortOrder ASC`.)
preferSites	If unique is set, this determines which site should be selected when querying multi-site elements.
prepareSubquery	Prepares the element query and returns its subquery (which determines what elements will be returned).
price	Narrows the query results based on the variants’ price.
product	Narrows the query results based on the variants’ product.
productId	Narrows the query results based on the variants’ products’ IDs.
relatedTo	Narrows the query results to only variants that are related to certain other elements.
search	Narrows the query results to only variants that match a search query.
site	Determines which site(s) the variants should be queried in.
siteId
siteSettingsId	Narrows the query results based on the variants’ IDs in the `elements_sites` table.
sku	Narrows the query results based on the variants’ SKUs.
status
stock	Narrows the query results based on the variants’ stock.
title	Narrows the query results based on the variants’ titles.
trashed	Narrows the query results to only variants that have been soft-deleted.
typeId	Narrows the query results based on the variants’ product types, per their IDs.
uid	Narrows the query results based on the variants’ UIDs.
unique	Determines whether only elements with unique IDs should be returned by the query.
weight	Narrows the query results based on the variants’ weight dimension.
width	Narrows the query results based on the variants’ width dimension.
with	Causes the query to return matching variants eager-loaded with related elements.

# `afterPopulate`

Performs any post-population processing on elements.

# `andRelatedTo`

Narrows the query results to only variants that are related to certain other elements.

See Relations (opens new window) for a full explanation of how to work with this parameter.

Twig
PHP

{# Fetch all variants that are related to myCategoryA and myCategoryB #}
{% set variants = craft.variants()
  .relatedTo(myCategoryA)
  .andRelatedTo(myCategoryB)
  .all() %}

# `asArray`

Causes the query to return matching variants as arrays of data, rather than Variant (opens new window) objects.

Twig
PHP

{# Fetch variants as arrays #}
{% set variants = craft.variants()
  .asArray()
  .all() %}

# `cache`

Enables query cache for this Query.

# `clearCachedResult`

Clears the cached result (opens new window).

# `dateCreated`

Narrows the query results based on the variants’ creation dates.

Possible values include:

Value	Fetches variants…
`'>= 2018-04-01'`	that were created on or after 2018-04-01.
`'< 2018-05-01'`	that were created before 2018-05-01.
`['and', '>= 2018-04-04', '< 2018-05-01']`	that were created between 2018-04-01 and 2018-05-01.
`now`/`today`/`tomorrow`/`yesterday`	that were created at midnight of the specified relative date.

Twig
PHP

{# Fetch variants created last month #}
{% set start = date('first day of last month')|atom %}
{% set end = date('first day of this month')|atom %}

{% set variants = craft.variants()
  .dateCreated(['and', ">= #{start}", "< #{end}"])
  .all() %}

# `dateUpdated`

Narrows the query results based on the variants’ last-updated dates.

Possible values include:

Value	Fetches variants…
`'>= 2018-04-01'`	that were updated on or after 2018-04-01.
`'< 2018-05-01'`	that were updated before 2018-05-01.
`['and', '>= 2018-04-04', '< 2018-05-01']`	that were updated between 2018-04-01 and 2018-05-01.
`now`/`today`/`tomorrow`/`yesterday`	that were updated at midnight of the specified relative date.

Twig
PHP

{# Fetch variants updated in the last week #}
{% set lastWeek = date('1 week ago')|atom %}

{% set variants = craft.variants()
  .dateUpdated(">= #{lastWeek}")
  .all() %}

# `fixedOrder`

Causes the query results to be returned in the order specified by id.

If no IDs were passed to id, setting this to true will result in an empty result set.

Twig
PHP

{# Fetch variants in a specific order #}
{% set variants = craft.variants()
  .id([1, 2, 3, 4, 5])
  .fixedOrder()
  .all() %}

# `hasProduct`

Narrows the query results to only variants for certain products.

Possible values include:

Value	Fetches variants…
a ProductQuery (opens new window) object	for products that match the query.

# `hasSales`

Narrows the query results to only variants that are on sale.

Possible values include:

Value	Fetches variants…
`true`	on sale
`false`	not on sale

# `hasStock`

Narrows the query results to only variants that have stock.

Possible values include:

Value	Fetches variants…
`true`	with stock.
`false`	with no stock.

# `hasUnlimitedStock`

Narrows the query results to only variants that have been set to unlimited stock.

Possible values include:

Value	Fetches variants…
`true`	with unlimited stock checked.
`false`	with unlimited stock not checked.

# `height`

Narrows the query results based on the variants’ height dimension.

Possible values include:

Value	Fetches variants…
`100`	with a height of 100.
`'>= 100'`	with a height of at least 100.
`'< 100'`	with a height of less than 100.

# `id`

Narrows the query results based on the variants’ IDs.

Possible values include:

Value	Fetches variants…
`1`	with an ID of 1.
`'not 1'`	not with an ID of 1.
`[1, 2]`	with an ID of 1 or 2.
`['not', 1, 2]`	not with an ID of 1 or 2.

Twig
PHP

{# Fetch the variant by its ID #}
{% set variant = craft.variants()
  .id(1)
  .one() %}

This can be combined with fixedOrder if you want the results to be returned in a specific order.

# `ignorePlaceholders`

Causes the query to return matching variants as they are stored in the database, ignoring matching placeholder elements that were set by craft\services\Elements::setPlaceholderElement() (opens new window).

# `inReverse`

Causes the query results to be returned in reverse order.

Twig
PHP

{# Fetch variants in reverse #}
{% set variants = craft.variants()
  .inReverse()
  .all() %}

# `isDefault`

Narrows the query results to only default variants.

Twig
PHP

{# Fetch default variants #}
{% set variants = craft.variants()
  .isDefault()
  .all() %}

# `length`

Narrows the query results based on the variants’ length dimension.

Possible values include:

Value	Fetches variants…
`100`	with a length of 100.
`'>= 100'`	with a length of at least 100.
`'< 100'`	with a length of less than 100.

# `limit`

Determines the number of variants that should be returned.

Twig
PHP

{# Fetch up to 10 variants  #}
{% set variants = craft.variants()
  .limit(10)
  .all() %}

# `maxQty`

Narrows the query results based on the variants’ max quantity.

Possible values include:

Value	Fetches variants…
`100`	with a maxQty of 100.
`'>= 100'`	with a maxQty of at least 100.
`'< 100'`	with a maxQty of less than 100.

# `minQty`

Narrows the query results based on the variants’ min quantity.

Possible values include:

Value	Fetches variants…
`100`	with a minQty of 100.
`'>= 100'`	with a minQty of at least 100.
`'< 100'`	with a minQty of less than 100.

# `offset`

Determines how many variants should be skipped in the results.

Twig
PHP

{# Fetch all variants except for the first 3 #}
{% set variants = craft.variants()
  .offset(3)
  .all() %}

# `orderBy`

Determines the order that the variants should be returned in. (If empty, defaults to sortOrder ASC.)

Twig
PHP

{# Fetch all variants in order of date created #}
{% set variants = craft.variants()
  .orderBy('dateCreated ASC')
  .all() %}

# `preferSites`

If unique is set, this determines which site should be selected when querying multi-site elements.

If this isn’t set, then preference goes to the current site.

Twig
PHP

{# Fetch unique variants from Site A, or Site B if they don’t exist in Site A #}
{% set variants = craft.variants()
  .site('*')
  .unique()
  .preferSites(['a', 'b'])
  .all() %}

# `prepareSubquery`

Prepares the element query and returns its subquery (which determines what elements will be returned).

# `price`

Narrows the query results based on the variants’ price.

Possible values include:

Value	Fetches variants…
`100`	with a price of 100.
`'>= 100'`	with a price of at least 100.
`'< 100'`	with a price of less than 100.

# `product`

Narrows the query results based on the variants’ product.

Possible values include:

Value	Fetches variants…
a Product (opens new window) object	for a product represented by the object.

# `productId`

Narrows the query results based on the variants’ products’ IDs.

Possible values include:

Value	Fetches variants…
`1`	for a product with an ID of 1.
`[1, 2]`	for product with an ID of 1 or 2.
`['not', 1, 2]`	for product not with an ID of 1 or 2.

# `relatedTo`

Narrows the query results to only variants that are related to certain other elements.

See Relations (opens new window) for a full explanation of how to work with this parameter.

Twig
PHP

{# Fetch all variants that are related to myCategory #}
{% set variants = craft.variants()
  .relatedTo(myCategory)
  .all() %}

# `search`

Narrows the query results to only variants that match a search query.

See Searching (opens new window) for a full explanation of how to work with this parameter.

Twig
PHP

{# Get the search query from the 'q' query string param #}
{% set searchQuery = craft.app.request.getQueryParam('q') %}

{# Fetch all variants that match the search query #}
{% set variants = craft.variants()
  .search(searchQuery)
  .all() %}

# `site`

Determines which site(s) the variants should be queried in.

The current site will be used by default.

Possible values include:

Value	Fetches variants…
`'foo'`	from the site with a handle of `foo`.
`['foo', 'bar']`	from a site with a handle of `foo` or `bar`.
`['not', 'foo', 'bar']`	not in a site with a handle of `foo` or `bar`.
a craft\models\Site (opens new window) object	from the site represented by the object.
`'*'`	from any site.

If multiple sites are specified, elements that belong to multiple sites will be returned multiple times. If you only want unique elements to be returned, use unique in conjunction with this.

Twig
PHP

{# Fetch variants from the Foo site #}
{% set variants = craft.variants()
  .site('foo')
  .all() %}

# `siteId`

# `siteSettingsId`

Narrows the query results based on the variants’ IDs in the elements_sites table.

Possible values include:

Value	Fetches variants…
`1`	with an `elements_sites` ID of 1.
`'not 1'`	not with an `elements_sites` ID of 1.
`[1, 2]`	with an `elements_sites` ID of 1 or 2.
`['not', 1, 2]`	not with an `elements_sites` ID of 1 or 2.

Twig
PHP

{# Fetch the variant by its ID in the elements_sites table #}
{% set variant = craft.variants()
  .siteSettingsId(1)
  .one() %}

# `sku`

Narrows the query results based on the variants’ SKUs.

Possible values include:

Value	Fetches variants…
`'foo'`	with a SKU of `foo`.
`'foo*'`	with a SKU that begins with `foo`.
`'*foo'`	with a SKU that ends with `foo`.
`'foo'`	with a SKU that contains `foo`.
`'not foo'`	with a SKU that doesn’t contain `foo`.
`['foo', 'bar'`	with a SKU that contains `foo` or `bar`.
`['not', 'foo', 'bar']`	with a SKU that doesn’t contain `foo` or `bar`.

Twig
PHP

{# Get the requested variant SKU from the URL #}
{% set requestedSlug = craft.app.request.getSegment(3) %}

{# Fetch the variant with that slug #}
{% set variant = craft.variants()
  .sku(requestedSlug|literal)
  .one() %}

# `status`

# `stock`

Narrows the query results based on the variants’ stock.

Possible values include:

Value	Fetches variants…
`0`	with no stock.
`'>= 5'`	with a stock of at least 5.
`'< 10'`	with a stock of less than 10.

# `title`

Narrows the query results based on the variants’ titles.

Possible values include:

Value	Fetches variants…
`'Foo'`	with a title of `Foo`.
`'Foo*'`	with a title that begins with `Foo`.
`'*Foo'`	with a title that ends with `Foo`.
`'Foo'`	with a title that contains `Foo`.
`'not Foo'`	with a title that doesn’t contain `Foo`.
`['Foo', 'Bar']`	with a title that contains `Foo` or `Bar`.
`['not', 'Foo', 'Bar']`	with a title that doesn’t contain `Foo` or `Bar`.

Twig
PHP

{# Fetch variants with a title that contains "Foo" #}
{% set variants = craft.variants()
  .title('*Foo*')
  .all() %}

# `trashed`

Narrows the query results to only variants that have been soft-deleted.

Twig
PHP

{# Fetch trashed variants #}
{% set variants = craft.variants()
  .trashed()
  .all() %}

# `typeId`

Narrows the query results based on the variants’ product types, per their IDs.

Possible values include:

Value	Fetches variants…
`1`	for a product of a type with an ID of 1.
`[1, 2]`	for product of a type with an ID of 1 or 2.
`['not', 1, 2]`	for product of a type not with an ID of 1 or 2.

# `uid`

Narrows the query results based on the variants’ UIDs.

Twig
PHP

{# Fetch the variant by its UID #}
{% set variant = craft.variants()
  .uid('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')
  .one() %}

# `unique`

Determines whether only elements with unique IDs should be returned by the query.

This should be used when querying elements from multiple sites at the same time, if “duplicate” results is not desired.

Twig
PHP

{# Fetch unique variants across all sites #}
{% set variants = craft.variants()
  .site('*')
  .unique()
  .all() %}

# `weight`

Narrows the query results based on the variants’ weight dimension.

Possible values include:

Value	Fetches variants…
`100`	with a weight of 100.
`'>= 100'`	with a weight of at least 100.
`'< 100'`	with a weight of less than 100.

# `width`

Narrows the query results based on the variants’ width dimension.

Possible values include:

Value	Fetches variants…
`100`	with a width of 100.
`'>= 100'`	with a width of at least 100.
`'< 100'`	with a width of less than 100.

# `with`

Causes the query to return matching variants eager-loaded with related elements.

See Eager-Loading Elements (opens new window) for a full explanation of how to work with this parameter.

Twig
PHP

{# Fetch variants eager-loaded with the "Related" field’s relations #}
{% set variants = craft.variants()
  .with(['related'])
  .all() %}

Was this page helpful?

Parts of this page are generated or assembled by automations. While we greatly appreciate contributions to the documentation, reporting automated content issues will allow us to fix them at the source!

Products & Variants

# Products

# Product Types

# Product Type Options

# Tax & Shipping

# Product Fields

# Variant Fields

# Templating

# Displaying a Product Type

# Listing Product Types

# Querying Products

# Example

# Eager-loading

# Product Query Parameters

# after

# afterPopulate

# andRelatedTo

# asArray

# before

# cache

# clearCachedResult

# dateCreated

# dateUpdated

# defaultHeight

# defaultLength

# defaultPrice

# defaultSku

# defaultWeight

# defaultWidth

# eagerly

# expiryDate

# fixedOrder

# hasVariant

# id

# ignorePlaceholders

# inBulkOp

# inReverse

# language

# limit

# offset

# orderBy

# postDate

# preferSites

# prepForEagerLoading

# prepareSubquery

# relatedTo

# render

# search

# site

# siteId

# siteSettingsId

# slug

# status

# title

# trashed

# type

# typeId

# uid

# unique

# uri

# wasCountEagerLoaded

# wasEagerLoaded

# with

# withCustomFields

# Variants

# Prices

# Promotional Price

# Sale Price

# Stock

# Physical Properties

# SKUs

# Tax & Shipping Categories

# Default Variant

# Querying Variants

# Example

# Variant Query Parameters

# afterPopulate

# andRelatedTo

# asArray

# cache

# `after`

# `afterPopulate`

# `andRelatedTo`

# `asArray`

# `before`

# `cache`

# `clearCachedResult`

# `dateCreated`

# `dateUpdated`

# `defaultHeight`

# `defaultLength`

# `defaultPrice`

# `defaultSku`

# `defaultWeight`

# `defaultWidth`

# `eagerly`

# `expiryDate`

# `fixedOrder`

# `hasVariant`

# `id`

# `ignorePlaceholders`

# `inBulkOp`

# `inReverse`

# `language`

# `limit`

# `offset`

# `orderBy`

# `postDate`

# `preferSites`

# `prepForEagerLoading`

# `prepareSubquery`

# `relatedTo`

# `render`

# `search`

# `site`

# `siteId`

# `siteSettingsId`

# `slug`

# `status`

# `title`

# `trashed`

# `type`

# `typeId`

# `uid`

# `unique`

# `uri`

# `wasCountEagerLoaded`

# `wasEagerLoaded`

# `with`

# `withCustomFields`

# `afterPopulate`

# `andRelatedTo`

# `asArray`

# `cache`

# `clearCachedResult`

# `dateCreated`

# `dateUpdated`

# `fixedOrder`

# `hasProduct`

# `hasSales`

# `hasStock`

# `hasUnlimitedStock`

# `height`

# `id`

# `ignorePlaceholders`

# `inReverse`

# `isDefault`

# `length`

# `limit`

# `maxQty`

# `minQty`

# `offset`

# `orderBy`

# `preferSites`

# `prepareSubquery`

# `price`

# `product`

# `productId`

# `relatedTo`

# `search`