Skip to main content
GET
Get Search Query Auto-Suggestions
Before calling this endpoint, make sure you’ve generated an API token and picked the correct domain. See Authentication & Base URLs. Use this for typeahead as the shopper types. To run the actual product search, use Search Products.

Headers

x-tenant-id
string
required

Identifies your organization. Ensures data isolation per tenant.

x-workspace-id
string
required

Identifies the workspace within your organization. Scopes resources to a specific workspace.

x-environment-id
string
required

Identifies the environment you are targeting. Scopes the call to a specific deployment environment.

Query Parameters

catalog_id
string
required

Catalog to search within.

q
string

Partial query to return suggestions for.

locale
string

Locale for the suggestions.

limit
integer
default:10

Maximum number of suggestions to return.

skip
integer
default:0

Number of suggestions to skip.

is_auto_spell_correction
boolean

Apply automatic spell correction to the query.

did_you_mean_limit
integer

Maximum number of did-you-mean suggestions to return.

Response

Success.

Typeahead suggestions for a partial query.

terms
string[]

Suggested search terms, ordered by relevance. Capped by limit. Empty when nothing matches.

did_you_mean
string[]

Spelling alternatives for the query, capped by did_you_mean_limit. Empty when q is omitted.