Resolve
Resolve v2
Query Parameters
| Parameter | Details |
|---|---|
term
| 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
| Parameter | Details |
|---|---|
X-Shop-Id | integer Example: 10001 |
Responses
200
Found a matching entity
application/json
Success
One of:
object
typerequired
string
Example:
category
required
object
object
typerequired
string
Example:
product
required
object
object
typerequired
string
Example:
navigationItem
required
object
204
Unable to match an entity
Success
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
Request samples
Response samples
200ProductSuggestion:
Content type: application/json
categorySuggestion:
Content type: application/json
navigationSuggestion:
Content type: application/json
Resolve v1
Query Parameters
| Parameter | Details |
|---|---|
term
| string Example: pants black |
categoryId | integer Example: 20201 |
Responses
200
successful operation
application/json
Success
Array of object
400
term not provided
Error
401
authentication failed
Error
422
formal validation failure (see schema)
Error
GET
