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
- Create a rule group with a unique
slug. - Add rules to the group with
execution_order, atrigger(exactorcontains), andactions.boosts(filter condition + weight). - Attach the group to a search profile via the ordered
rule_groupsarray (group UUIDs earlier in the array run first). - 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
| Field | Scope | Behaviour |
|---|---|---|
rule_groups array position | Across attached groups | Earlier array entry runs first |
execution_order on a rule | Within a group | Lower 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.
📄️ Create search rule group
Create a new search rule group for the current tenant. The `slug` must be unique within the tenant.
📄️ List search rule groups
List search rule groups for the current tenant with offset/limit pagination.
📄️ Get search rule group
Get a search rule group by ID.
📄️ Update search rule group
Update the slug and/or description of a search rule group. This label-only change does not alter rule evaluation.
📄️ Delete search rule group
Delete a search rule group by ID. Rules in the group are cascade-deleted.