The Search API provides a slice_id operator to apply merchandising operations on the products sliced by Variant slicing.
Also pass slice_id in the fl parameter when working with Variant slicing in the API calls for configurations that target specific product variants. This returns a slice_id field in the response, which is required to identify and operate on individual sliced variants for boosting, burying, or other merchandising actions.
Note: API controls to disable merchandising rules apply to Variant slicing rules as well.
Slice-based product ranking
| Merchandising operation | Parameter syntax | Example | Dashboard + API: Rule merging |
|---|---|---|---|
| Hard Boost (Boost to Top) | boost=slice_id:"<value>" | &boost=slice_id:"H95478:8" | All distinct slice_ids boosted from the dashboard and via the API are combined. |
| Hard Bury (Bury to Bottom) | bury=slice_id:"<value>" | &bury=slice_id:"H95478:8" | All distinct slice_ids buried from the dashboard and via the API are combined. |
| Block | efq=-slice_id:"<value>" | &efq=-slice_id:"H95478:8" | All distinct slice_ids blocked from the dashboard and via the API are combined. Note: The "-" before slice_id denotes exclusion. |
Note: The Lock in position operation isn’t supported.
Attribute-based slice ranking
| Merchandising operation | Parameter syntax | Example | Dashboard + API: Rule merging |
|---|---|---|---|
| Soft Boost | soft_boost=slice_id:"<value>"^<boost_strength> | &soft_boost=slice_id:"H95478:8"^100 | API rule adds an additional boost on top of the dashboard rule. Rules applied sequentially. Avoid sending multiple slice IDs. |
| Soft Bury | soft_bury=slice_id:"<value>"^<bury_strength> | &soft_bury=slice_id:"H95478:8"^25 | API rule adds additional burying on top of the dashboard rule. Rules applied sequentially. |
| Include Only | include=slice_id:"<value>" | &include=slice_id:"H95478:8" | API rule applied as a new include rule on top of the dashboard rule. |
| Exclude | exclude=slice_id:"<value>" | &exclude=slice_id:"H95478:8" | API rule applied as a new exclude rule on top of the dashboard rule. |
Boolean operations with slice_id
slice_id| Operator | Syntax | Example |
|---|---|---|
| OR | slice_id:"<value1>" OR "<value2>" | &soft_boost=slice_id:"H95478:8" OR "H95478:10"^25 |
| AND | slice_id:"<value1>" AND "<value2>" | &soft_boost=slice_id:"H95478:8" AND "H95478:10"^25 |
| NOT | slice_id:!"<value>"!slice_id:"<value>" | &soft_boost=slice_id:!"H95478:8" |