Commerce Webstore Search Boost and Bury Rules, Create

Keep these considerations in mind when using boost and bury rules to influence search results.

• Boost and bury rules aren’t intended for precise control over ranking products in your search results.
• Boost and bury rules influence how products are ranked in search results, but they don’t override them.
• A product being boosted appears earlier and is ranked higher in the search results relative to its ranking without the rule and not relative to other products.
• Boost and bury rules don’t guarantee that products with a higher boost value appear before products with a lower boost value.
• Boost and bury rules only apply when the Best Match sort rule uses a relevance score to rank products.

Resource

1/commerce/management/webstores/${webstoreId}/search/boost-bury-rules

Available version

59.0

HTTP methods

GET POST

Response body for GET

Boost and Bury Rules Collection

Request body for POST

Boost and Bury Rule Input

Root XML tag

searchBoostBuryRule

JSON example

1{
2    "name": "Medium boost all Alpine products",
3    "action": "Boost",
4    "level": 70,
5    "targetExpression": {
6        "conditions": [
7            {
8                "attributeNameOrId": "Id",
9                "attributeType": "Product2",
10                "values": ["01txx0000006iiOAAQ","01txx0000006ij4AAA"]
11            }
12        ]
13    },
14    "startDate": "2023-07-31T00:10:00.000Z",
15    "endDate": "2023-08-31T00:10:00.000Z"
16}

Properties

Name	Type	Description	Required or Optional	Available Version
action	String	Action of the boost and bury rule. Values are: Boost—Boost rule. Increases search result rankings for targeted products. Bury—Bury rule. Decreases search result rankings for targeted products.	Required	59.0
endDate	String	End date and time of the boost and bury rule.	Required	59.0
level	Integer	Level of the boost and bury rule. Values are from 1-100. The level determines the degree to which a boost and bury rule influences search result rankings for the targeted products.	Required	59.0
name	String	Name of the boost and bury rule.	Required	59.0
startDate	String	Start date and time of the boost and bury rule.	Required	59.0
targetExpression	Boost and Bury Rule Target Expression Input	Target expression for a boost and bury rule. The target expression specifies which products a boost and bury rule applies to.	Required	59.0

Response body for POST

Boost and Bury Rule