A valid request URL is required to generate request examplesSearch Debug
Searches the items displayed on the storefront for products or product options that the shopper types in a search query. Used for debugging.
A valid request URL is required to generate request examplesAuthorizations
JWT Authorization header using the Bearer scheme.
Query Parameters
The terms to search on.
A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.
The template to use for what facets to compute. ex: categoryId:id
If you only want to return a subset of the facets defined in the template. ex: category,price,rating
Fields to facet on in addition to the optionally provided facetTemplate. ex: category,price,rating
Facet field range. ex: field:[val+TO+val] can also label
Facet hierarchy prefix. Skip these levels on a hierarchical facet. ex: field:foo/bar/bing
Find the node to start with given a unique lookup value, instead of requiring a prefix path. ex: field:bing
Facet hierarchy depth. Number of levels to return. ex: category:1
Facet offset
Facet page size
Deprecated
Apply facet values as a filter. ex: category:3,price:[* TO 100]
The element to sort the results by and the order in which the results appear. Either ascending (a-z) or descending (z-a) order. Optional.
Whether to slice results or not
Used to page results from a query. Indicates the maximum number of entities to return from a query. The default value is 12 and the maximum value is 200. Optional.
Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. The default value is 0. Optional.
The name of a SiteSearchSettings (search relevancy settings) scheme to use. Defaults to whichever Settings is marked as IsDefault=true.
Use search-tuning-rules or not
The filters which the search tuning rules will match on.
Search-Tuning-Rule Code
A list of property groups to return instead of using the granular responseFields param. ex: categories,properties,options
Pass in * to begin a deep page operation. The response will include a nextCursorMark value. Pass this into the next call. Continue with this pattern until nextCursorMark is null.
Only respond with the request made to the search-engine, for one "groups" parameter value. Default is false. Optional parameter.
Personalization Id (Monetate Id)
Optional. Use a specific search-merchandizing-rule code if provided.
optional alternative to query for debugging tools
Response
Success