Skip to main content
GET
/
commerce
/
catalog
/
storefront
/
productsearch
/
suggest
Error
A valid request URL is required to generate request examples
{
  "query": "<string>",
  "suggestionGroups": [
    {
      "name": "<string>",
      "suggestions": [
        {
          "suggestionType": "<string>",
          "suggestion": "<unknown>"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Query Parameters

query
string

Comma delimited list of suggestion groups that should be returned. The default is everything

groups
string
pageSize
integer<int32>

Indicates the maximum number of entities to return from a query. The default value is 10 and the maximum value is 200. Optional.

mid
string
filter
string
responseFields
string

limits which fields are returned in the response body

Response

Success

List of items to suggest to the shopper who is entering a search query, for example, a search box on the storefront.

query
string | null

Text that the shopper types in a search query.

suggestionGroups
object[] | null

List of SearchSuggestionGroups