Include Search Rule

Include search rule.
Property Name Type Description Filter Group and Version Available Version
lastModifiedDate String Last modified date of the search result rule. Medium, 66.0 66.0
locales String[] Comma-separated list of up to 10 locales that the include search rule applies to. Medium, 58.0 58.0
ruleDefinition String[] Comma-separated list of terms that the include search rule applies to. Valid number of unique strings is from 2 through 5. Medium, 58.0 58.0
searchResultRuleId String ID of the include search rule. Small, 58.0 58.0
type String Type of search rule. Value is:
  • BidirectionalSynonym—Use when terms are interchangeable and should return the same results both ways. For example, jacket ⇄ winter coat. Available from API version 66.0 and later.
  • Include—When a term in a query matches any term in a ruleDefinition, Commerce Search returns results for all terms in the list. Supported in API versions 58.0 to 66.0.

    We suggest using BidirectionalSynonym, which returns equivalent results for interchangeable terms in both directions, unlike Include.

    Note

  • UnidirectionalSynonym—Use when one term should expand results, but not necessarily the reverse. For example, jacket → hoodie. Available from API version 66.0 and later.
Small, 58.0 58.0