Commerce Management Webstore Search, Include Rules

Create or retrieve search include rules for a webstore. You can create up to 25 rules for a webstore. Search include rules are not configurable in the UI.

Resource

1/commerce/management/webstores/webstoreId/search/results-rules

Available version

58.0

HTTP methods

GET, PUT

Response body for GET

Include Search Rules Collection

Request body for PUT

Root XML tag

<searchResultsRules>

JSON example

1{
2  "searchResultsRules" : [
3    {
4      "type" : "Include",
5      "ruleDefinition" : ["decaffeinated", "decaf"],
6      "locales" : ["en_US"]
7    },
8    {
9      "type" : "Include",
10      "ruleDefinition" : ["dog", "puppy"],
11      "locales" : ["en_US"]
12    },
13    {
14      "type" : "Include",
15      "ruleDefinition" : ["wintercoat", "jacket", "coat"],
16      "locales" : ["en_US"]
17    }
18  ]
19}

Properties

Name	Type	Description	Required or Optional	Available Version
`searchResultsRules`	Include Search Rule Input[]	A collection of include search rule inputs.	Required	58.0

Response body for PUT

Include Search Rules Collection

Connect REST API Developer Guide

Commerce Management Webstore Search, Include Rules