Skip to main content

​
Overview

Variant breakouts allow you to configure specific product options (like Stone, Color, or Size) to be displayed as individual variant tiles instead of a single product tile. This is useful when each variant represents a distinct item that customers want to browse and compare independently.

​
Before you begin

  • Ensure you have products with the option attribute you want to break out (e.g., products with a “Stone” option)
  • Verify that variants have unique images and meaningful differences
  • Consider which collections would benefit from variant breakouts

​
Create a variant breakout

  1. Go to Merchandising → Variant Breakouts in the dashboard
  2. Click Create Breakout
  3. Configure the breakout settings:

​
Name

Enter a descriptive name for your breakout configuration (e.g., “Stone Breakout” or “Color Breakout for Apparel”).

​
Option attribute

Select the product option attribute that should trigger the breakout. This dropdown shows all option attributes in your catalog (attributes that start with options.). Examples:
  • Stone - For jewelry with different gemstones
  • Color - For apparel with distinct colorways
  • Size - For products where size represents meaningfully different items
Select an option where each value represents a distinct item customers want to compare. Avoid options like “Size” for standard clothing where customers typically select size on the product page.

​
Applies to

Select where the variant breakout should be active:
  • Search & Collections - Applies to both search results and collection browse pages
  • Collections Only - Only applies to collection browse pages (Browse API)
  • Search Only - Only applies to search results (Search API)
You can use different strategies for search versus browse. For example, show variants in collections but keep products grouped in search results.

​
Target collections

Specify which collections should use this breakout:
  • All Collections - Leave this field empty to apply the breakout to all collections
  • Specific Collections - Select one or more collection handles to target specific collections
You cannot have overlapping collection targets for the same option code. Multiple breakouts with different option codes can target the same collections (including all collections), but breakouts with the same option code cannot overlap. If you try to create a breakout that targets collections already covered by another breakout with the same option code, you’ll receive a validation error.In addition, any product can only be targeted by one enabled breakout per applies-to surface, regardless of option code. Two product-targeted breakouts that both apply to the same surface (search results or collection pages) cannot list the same product — saving is rejected because the runtime only breaks a product out by one option code. A search-only breakout and a collections-only breakout can coexist on the same product; a breakout set to both still conflicts with any same-product breakout on either surface.

​
Target products

Specify which products should use this breakout:
  • All Products - Leave this field empty to apply the breakout to all products (within the target collections)
  • Specific Products - Select one or more products to target only those products
When you combine product targeting with collection targeting, the breakout uses AND logic: it only applies to the selected products within the selected collections. This allows you to create highly specific breakout configurations.
Each targeted product must have the breakout’s option. If you add an indexed product that lacks the option (for example, the option was renamed upstream), saving fails with a validation error. Products that are still indexing are allowed through and re-checked automatically once indexing completes. See unresolved targets for how mismatches are surfaced later.
Example use cases:
  • Target a specific product line within a broader collection
  • Create breakouts for featured products while keeping other products as standard tiles
  • Test variant breakouts on a subset of products before rolling out to an entire collection
Product targeting allows breakouts with the same option code to coexist on the same collections. A breakout with product targeting only applies to those specific products, so it won’t conflict with a breakout without product targeting (which applies to all other products).

​
Target blocks

Choose whether the breakout also applies to block recommendations:
  • Off (default) - Blocks continue to return standard product tiles.
  • On - Blocks return variant tiles for products in scope of the breakout, matching Browse and Search behavior.
Block targeting still respects the breakout’s product and collection targeting. Individual blocks can bypass variant breakouts using the Disable variant breakouts safeguard on the block itself.

​
Include option value in title

Control whether variant tile titles include the option value appended to the product title.
  • Enabled (default) - Variant tiles display titles in the format "{product title} - {option value}" (e.g., “Amethyst Ring - Rose Quartz”)
  • Disabled - Variant tiles use the original product title without modification
This setting allows you to customize how variant tiles are displayed based on your catalog structure and customer preferences.
Enable this option when the option value provides meaningful context (e.g., gemstone names, distinct colorways). Disable it when the product title already includes sufficient variant information or when you prefer a cleaner display.

​
Merchandising rule warnings

When configuring a breakout that applies to collections, the form displays a warning if any merchandising rules have the Disable Variant Breakouts option enabled. This alert lists the affected rule name, collection, and sort order so you know which collection pages will override your breakout. The warning updates automatically as you change the Applies To or Target Collections fields.

​
Save the breakout

When you are ready to save, you have two options:
  • Save Draft — Saves the breakout configuration without making it live. Use this to prepare and review your configuration before activating it.
  • Publish — Saves and immediately activates the breakout. Variant tiles will begin appearing in API responses right away.
New breakouts default to draft status. This lets you verify the configuration before it affects your storefront.

​
What happens next

Once your variant breakout is active:
  1. Products with the option will be expanded into individual variant tiles
  2. Products without the option will continue to display as standard product tiles
  3. API responses will include a __typename field identifying each tile as "Product" or "Variant"
  4. Total results and facet counts will reflect tile counts (not product counts)
  5. Pagination will operate on tiles

​
Example scenarios

​
Single option breakout

Goal: Display rings with different gemstones as individual tiles in the “Rings” collection. Configuration:
  • Name: Gemstone Breakout
  • Option Attribute: Stone
  • Applies To: Both
  • Target Collections: rings, gemstone-jewelry
  • Target Products: All products
  • Status: Published
Result: When customers browse the “Rings” collection, they see individual tiles for each gemstone variant (Amethyst Ring, Rose Quartz Ring, Tiger Eye Ring) instead of a single “Ring” product tile.

​
Multiple option breakouts in the same collection

Goal: Display both jewelry with different gemstones and apparel with different colors as individual tiles in the “New Arrivals” collection. Configuration 1:
  • Name: Gemstone Breakout
  • Option Attribute: Stone
  • Applies To: Both
  • Target Collections: All collections
  • Target Products: All products
  • Status: Published
Configuration 2:
  • Name: Color Breakout
  • Option Attribute: Color
  • Applies To: Both
  • Target Collections: All collections
  • Target Products: All products
  • Status: Published
Result: In the “New Arrivals” collection, jewelry products are broken out by stone (showing individual gemstone variants). Apparel products are broken out by color (showing individual colorway variants). Products without either option display as standard product tiles.

​
Product-specific targeting

Goal: Break out only specific premium rings by gemstone in the “Rings” collection, while keeping other rings as standard product tiles. Configuration:
  • Name: Premium Gemstone Breakout
  • Option Attribute: Stone
  • Applies To: Both
  • Target Collections: rings
  • Target Products: Premium Amethyst Ring, Premium Rose Quartz Ring, Premium Tiger Eye Ring
  • Status: Published
Result: Only the three selected premium ring products are broken out into individual gemstone variant tiles. All other rings in the collection display as standard product tiles. This allows you to highlight specific products while maintaining a cleaner display for the rest of your catalog.

​
Combining product and collection targeting

Goal: Break out color variants for a specific apparel line only within the “Sale” collection. Configuration:
  • Name: Sale Apparel Color Breakout
  • Option Attribute: Color
  • Applies To: Both
  • Target Collections: sale
  • Target Products: Summer Hoodie, Beach T-Shirt, Sunset Joggers
  • Status: Published
Result: The three selected apparel products are broken out by color, but only when browsing the “Sale” collection. In other collections (like “New Arrivals” or “All Products”), these same products display as standard product tiles. This demonstrates the AND logic: the breakout applies to selected products AND selected collections.

​
Coexisting breakouts with product targeting

Goal: Create two different color breakouts for different product lines in the same collection. Configuration 1:
  • Name: Premium Apparel Color Breakout
  • Option Attribute: Color
  • Applies To: Both
  • Target Collections: clothing
  • Target Products: Premium Hoodie, Premium T-Shirt
  • Status: Published
Configuration 2:
  • Name: Basic Apparel Color Breakout
  • Option Attribute: Color
  • Applies To: Both
  • Target Collections: clothing
  • Target Products: Basic Hoodie, Basic T-Shirt
  • Status: Published
Result: Both breakouts use the same option code (Color) and target the same collection (clothing), but they don’t conflict because they target different products. The premium products are broken out by the first breakout, and the basic products are broken out by the second breakout. This is possible because product targeting creates distinct scopes that don’t overlap.

​
Troubleshooting

  • Verify the breakout is published (not in draft status)
  • Check that you’re viewing a collection or search result where the breakout applies
  • Ensure products in the collection have the specified option attribute
  • Confirm the option attribute name matches exactly (case-sensitive)
An enabled breakout already covers the collections or products you selected. The validation rules are:
  • Breakouts with product targeting can coexist with breakouts without product targeting — the product-targeted one wins for its products, and the catch-all covers everything else.
  • Breakouts with the same option code that both omit product targeting cannot overlap on collections.
  • Any product can only be targeted by one enabled breakout per applies-to surface, regardless of option code. Two product-targeted breakouts that both apply to the same surface (search results or collection pages) cannot list the same product — the runtime breaks a product out by a single option code, so the second would silently do nothing. A search-only breakout and a collections-only breakout can share a product; a breakout set to both conflicts with any same-product breakout on either surface.
To resolve the error, you can:
  • Remove the overlapping product from one of the breakouts.
  • Disable one of the conflicting breakouts.
  • Narrow the target collections so the two breakouts no longer overlap.
  • Split the breakouts by surface — set one to search only and the other to collections only so they no longer run in the same query.
Note: Multiple breakouts with different option codes can still target the same collections when they target different products.
Facet counts reflect unique tile counts, not total variant counts. When a product is broken out by an option (e.g., Color), the facet count increases by the number of unique option values, not the total number of variants.Example: A product with 4 variants (Red/S, Red/M, Blue/S, Blue/M) broken out by Color produces 2 tiles (Red, Blue) and contributes 2 to facet counts, not 4.This ensures facet counts match the number of unique tiles displayed in results.
Ensure each variant has its own image assigned in Shopify. Variant breakouts work best when variants have distinct visual representations.

​
Next steps

​
See also