Wayfair Autocomplete API returns the search terms that Wayfair suggests for a typed text, in the language of the chosen storefront. Related searches and suggested products are returned when Wayfair offers them and are empty lists otherwise. A text with no suggestion returns an empty list.
Credits: 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
Typed text, 2 to 100 characters. Example: sofa.
coffee shops
string
Optional
Storefront: com (default), ca or co.uk. SKUs, slugs and category ids differ per storefront: use ids from the same storefront.
example.com
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": "sofa",
"products": [],
"suggestions": [
{
"keyword": "reclining sofa",
"category_id": null
},
{
"keyword": "outdoor sofa",
"category_id": null
}
],
"related_searches": []
},
"meta": {
"credits": 1,
"billable": true,
"endpoint_family": "autocomplete"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A parameter is missing or invalid, or an id does not belong to the request. This response is not billable.
{
"errors": {
"domain": [
"The domain must be com, ca or co.uk."
]
},
"message": "The request validation failed"
}Upstream Unavailable
Wayfair could not be reached, blocked the request or returned data that does not match the request (another page, another sort, a partly loaded grid). This response is not billable and is retryable.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "autocomplete"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "Wayfair could not be reached. Please retry shortly."
},
"success": false
}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.