Search (v3)
Get Suggestions
Returns suggestions for a given query. Call this while the user is typing to help
the user find what they're looking for. The suggestions are of two types:
- suggestions for search queries that are related to the current query
- suggestions for listings that are related to the current query
Example response:
<pre>
{
"suggestions_request_id": "c6fa5efd-1bde-43a8-9ac4-434605f53024",
"suggestions": [
{
"type": "query",
"title": "red hat",
"suggestions_result_id": "60c54958-8f2d-4ffd-a343-d316e79593b8"
},
{
"type": "listing",
"title": "Hats",
"listing_id": "b6fa5efd-1bde-43a8-9ac4-434605f53024",
"external_id": "1011",
"listing_type": "category",
"show_in_breadcrumbs": true,
"show_in_quicklinks": true,
"slug": "hats",
"ancestors": [
{
"title": "Accessories",
"listing_id": "a6fa5efd-1bde-43a8-9ac4-434605f53024",
"external_id": "1001",
"listing_type": "category",
"show_in_breadcrumbs": true,
"show_in_quicklinks": true,
"slug": "accessories"
},
]
"suggestions_result_id": "2aafccb2-cd21-4153-94bf-16c4eccefe67"
},
]
}
</pre>
GET
/
v3
/
search
/
suggestions
Query Parameters
merchant
string
requiredmarket
string
requiredlocale
string
requiredquery
string | null
session_id
string | null
Minimum length:
1
port
integer | null
Response
200 - application/json
suggestions_request_id
string
requiredsuggestions
object[]
requiredList of suggestions for search queries and product listings that should be shown to the user while they are typing.
Was this page helpful?