Skip to main content

Search Rule Groups

Search Rule Groups are named containers for merchandising rules that run at query time in catalog-search. Each group holds rules with exact, contains, or browse triggers and boost/bury, pin, hide, query-rewrite, and filter actions.

How rule groups work

  1. Create a rule group with a unique slug.
  2. Add rules to the group with execution_order, a trigger (exact or contains), and actions.boosts (filter condition + weight).
  3. Attach the group to a search profile via the ordered rule_groups array (group UUIDs earlier in the array run first).
  4. Search using that profile — matching rules apply boost or bury as part of result ranking.

Non-empty rule_groups activates query-time rules on every search for that profile. Rule actions (e.g. boost/bury) apply only when a trigger matches the shopper query; unmatched queries keep profile ranking. Clear the array for profile-only behaviour.

Execution order

FieldScopeBehaviour
rule_groups array positionAcross attached groupsEarlier array entry runs first
execution_order on a ruleWithin a groupLower integer runs first; must be unique per group

Tenancy

Rule groups follow the same organization/store tenancy model as search profiles. A profile may only reference rule groups visible to its tenant.

Ask External AI