Return public autocomplete keywords and their weights for a query. This endpoint is an aid for building search queries. It never returns product ids, so a suggested keyword must not be passed to the item endpoint. Failed requests are never charged.
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.
string
Required
Keywords to complete.
coffee shops
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"query": "phone",
"suggestions": [
{
"weight": 1000,
"keyword": "phone case"
}
],
"is_product_id_source": false
},
"meta": {
"billable": true,
"endpoint_family": "suggest"
},
"success": true
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A query is required. Not billable.
{
"message": "The request validation failed"
}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.