Overview
You can edit existing variant breakouts to change their configuration, enable/disable them, or delete them entirely.Edit a variant breakout
- Go to Merchandise → Variant Breakouts in the dashboard
- Find the breakout you want to edit in the list
- Click the breakout name to open the edit page
- Modify any of the following settings:
Editable fields
- Name — Update the descriptive name (editable inline in the page header)
- Option Attribute — Change which product option triggers the breakout
- Surface — Modify where the breakout is active (Search & Collections, Collections Only, or Search Only)
- Target Collections — Add or remove collection targets
- Target Products — Add or remove product targets
- Conditions — Add, edit, or remove variant-level exclusion conditions that keep matching variants from breaking out
- Include Option Value in Title — Control whether the option value is appended to the product title in variant tiles
- Click Save Changes to apply your modifications
Warnings about pinned variant tiles
Merchandising rules can pin variant tiles that depend on a breakout serving them. When a change to a breakout stops serving pinned variant tiles, the confirmation reports which rules are affected and how many pins each rule loses. For example: “This change stopped serving 4 pinned variant tiles: Statement Rings (3), New Arrivals (1).” The warning appears when you:- Save an edit that narrows the breakout’s coverage, such as adding target collections to a store-wide breakout, removing a target collection or product, adding an exclusion, or moving Applies To off collections
- Disable, unpublish, or delete the breakout
Option attribute and exclusion condition edits rebuild the breakout’s targets in the background, so their impact on pins isn’t known at save time. Check the affected rules in the merchandising editor after the rebuild completes.
Publish or unpublish a breakout
You can control whether a breakout is live using the Publish and Unpublish buttons in the page header:- Go to the breakout’s edit page
- Click Publish to make a draft breakout live, or Unpublish to revert a published breakout to draft status
Draft breakouts are saved but not applied to results. Use drafts for testing or for temporarily reverting to standard product tiles without losing your configuration.
Saving, publishing, or unpublishing a breakout triggers a background rebuild of its collection scope. A Publishing variant breakout toast appears while the rebuild runs and updates to a Published confirmation when the change has propagated. Only the person who made the change sees these toasts.
Review unresolved targets
When a breakout targets specific products, the breakout list and edit page flag any targets that Layers cannot break out. Use these flags to catch stale product ids and options that have drifted (for example, a product whose option was renamed upstream).On the breakouts list
A small warning icon appears next to a breakout’s name when it has one or more unresolved targets. Hover the icon to see how many targets could not be resolved and the reason: the products are missing, still indexing, or excluded by the breakout’s own exclusion conditions. Open the breakout to see the per-product cause and fix it.On the edit page
Each selected product row shows an inline status when the target cannot be broken out:no "<option>" option— The product is indexed but does not have the breakout’s option. Remove it, select a product that has the option, or change the breakout’s option attribute.product not yet indexed— The product is still indexing. The target is kept and re-checked automatically once indexing completes.only one value for this option— The product only has one value for the option, so there is nothing to break out. Consider removing it.product not found— The product id no longer exists in the store. Remove it.excluded by conditions— Every candidate variant matches the breakout’s exclusion conditions, so nothing is left to tile. Loosen the conditions or drop the product from targeting.
You cannot save a breakout that targets an indexed product missing the option. The form returns a validation error. Not-yet-indexed products are allowed through so indexing lag does not block saves; Layers re-checks them on the next sync.
Delete a variant breakout
- Go to the breakout’s edit page
- Open the overflow menu (the three-dot icon in the page header)
- Click Delete Breakout
- Confirm the deletion in the dialog
What happens when you delete
- Layers permanently removes the breakout configuration
- Products immediately revert to standard product tiles
- API responses no longer include
__typenamefields (unless other breakouts are active) - Facet counts return to product-based counting
- You need to update any merchandising rules that pin variant tiles. The deletion confirmation lists the rules that lose pinned variant tiles, and the affected pins show a Not served here badge in the merchandising editor
Validation rules
When editing a breakout, Layers enforces these rules:Overlap prevention
You cannot publish a breakout if it collides with another published breakout at the same scope tier. The option code doesn’t matter: two breakouts can conflict even when they break out different options (for example, Color and Stone), because only one breakout ever applies to a given product on a given surface. A breakout’s scope tier comes from its targeting:- Tier 1 — Specific collections and specific products
- Tier 2 — Specific collections, all products
- Tier 3 — All collections, specific products
- Tier 4 — All collections, all products
- They are on the same tier. Breakouts on different tiers can cover the same products; the more specific (lower-numbered) tier wins for its products, and the broader one keeps running everywhere else.
- They run on the same surface. A Search Only breakout and a Collections Only breakout never conflict. A Search & Collections breakout shares a surface with both.
- Their collection scopes overlap, after subtracting each breakout’s excluded collections.
- For tiers 1 and 3, they also target at least one of the same products. Tier 2 and tier 4 breakouts cover every product in their scope, so a shared collection scope is enough to conflict.
- Add or remove product targeting or collection targeting so the two breakouts sit on different tiers, or
- Remove the overlapping products or collections from one of the breakouts, or
- Set one breakout to Search Only and the other to Collections Only, or
- Unpublish or delete the conflicting breakout
Option attribute validation
The option attribute must:- Exist in your catalog
- Be a valid option attribute (starts with
options.) - Have products that use this option
Best practices
Test changes before publishing
Test changes before publishing
When editing a breakout, consider unpublishing it first, making your changes, testing in a staging environment, then publishing it again.
Use descriptive names
Use descriptive names
Name your breakouts clearly so team members understand their purpose (e.g., “Gemstone Breakout for Jewelry” instead of “Breakout 1”).
Document your strategy
Document your strategy
Keep notes on why you configured breakouts for specific collections. Notes help when you review your merchandising strategy later.
Monitor impact on facets
Monitor impact on facets
After enabling or modifying a breakout, check your facet counts to confirm they match expectations.
Troubleshooting
I can't publish my breakout
I can't publish my breakout
Check for validation errors:
- Ensure no other published breakout at the same scope tier and on the same surface covers the same collections (and, for product-targeted breakouts, the same products). This applies regardless of option code. See Overlap prevention.
- Consider adding or removing product or collection targeting so the breakouts sit on different scope tiers
- Verify the option attribute exists and is spelled correctly
- Confirm you have products with this option in the target collections
Changes aren't appearing in results
Changes aren't appearing in results
- Verify the breakout is published after saving
- Clear any caching in your frontend application
- Check that you’re viewing a collection or search result where the breakout applies
I deleted a breakout by accident
I deleted a breakout by accident
Deletions are permanent. You’ll need to recreate the breakout with the same configuration. Consider unpublishing instead of deleting if you might need the configuration again.