Get public search suggestions for a text term. Returns suggested names, urls, categories and product ids read from suggestion urls. An optional store number narrows the answer. Costs 1 credit per successful request. Failed requests are not billed.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
1 required parameter needed before sending a request.
1 optional filter available.
string
Required
Text to complete, 1 to 100 characters.
example
string
Optional
Optional four-digit store number.
example
Errors
Handle these documented responses before retrying or showing customer-facing failures.
API Error
No usable suggestions were returned. The request is not billed.
Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.