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>

Authorizations

api_key

string

query

required

Query Parameters

merchant

string

required

market

string

required

locale

string

required

query

string | null

session_id

string | null

Minimum length: 1

Response

200

application/json

Successful Response

suggestions_request_id

string

required

suggestions

object[]

required

List of suggestions for search queries and product listings that should be shown to the user while they are typing.

• QuerySuggestion
• ListingSuggestion

Show child attributes

suggestions.suggestions_result_id

string

required

suggestions.query

string

required

The suggested search query.

suggestions.type

any