docs
  1. Storefront Api
  2. Resources
  3. Search
  4. Get Suggestions

Get suggestions

Suggestions v2

Query Parameters

ParameterDetails
term
  • required
string
Example:
jeans
with
Array of strings
Default:
[]
string
Example:
product.attributes
category.depth
integer
Example:
3
category.showHidden
boolean
Example:
true
categoryId
integer
Example:
20201
shopId
integer
Example:
10001

Header Parameters

ParameterDetails
X-Shop-Id
integer
Example:
10001

Responses

200
successful operation
application/json
Success
required
Array of undefined
400
Required query parameter missing / invalid
application/json
Error
401
Authentication information is missing or invalid
application/json
Error
429
Triggered when a client exceeds the API request limit.
application/json
Error
GET/v2/search/suggestions

Request samples

Response samples

200
Content type: application/json
Typeahead v1

Query Parameters

ParameterDetails
term
  • required
string
fullAttributeValue
boolean
limit
integer
with
Array of strings
string
categoryDepth
integer
Example:
3
categoryId
integer
Example:
20201

Request body

ParameterDetails
fuzziness
integer
Enum:
[
  0,
  1,
  2
]
categoryId
integer
Example:
20201
limit
integer
Example:
10
term
string

Responses

200
successful operation
application/json
Success
required
null
required
object
400
required query parameter missing / query parameter invalid
Error
401
authentication failed
Error
POST/v1/typeahead
Provide Feedback