Intelligent Search API v1
VTEX Intelligent Search is search solution for digital commerce that delivers relevant product results, autocomplete suggestions, and personalized experiences based on the catalog from the user's first interaction with the store. This API enables headless implementations to integrate VTEX Intelligent Search capabilities into custom storefronts.
This reference documents Intelligent Search API v1, which replaces the Intelligent Search API (Legacy) at /api/io/_v/api/intelligent-search/*.
If you are migrating from the legacy API, see Migrating to Intelligent Search API v1.
Common Parameters
| Parameter | Description |
|---|---|
{{accountName}} |
Name of your VTEX account. Used in the base URL. |
{{environment}} |
Environment to use. Typically vtexcommercestable for production. |
Endpoints
Autocomplete
| Summary | Method | Path |
|---|---|---|
| Get list of the 10 most searched terms | GET | /top-searches |
| Get list of suggested terms and attributes similar to the search term | GET | /autocomplete-suggestions |
| Get list of suggested terms similar to the search term | GET | /search-suggestions |
Product list page
| Summary | Method | Path |
|---|---|---|
| Get attempt of correction of a misspelled term | GET | /correction-search |
| Get list of banners registered for query | GET | /banners/{facets} |
| Search products | GET | /product-search/{facets} |
| List filters for a search | GET | /facets/{facets} |
Product details page (PDP)
| Summary | Method | Path |
|---|---|---|
| Get product | GET | /products |
Delivery Promise
| Summary | Method | Path |
|---|---|---|
| Get pickup point availability for Delivery Promise | GET | /pickup-point-availability/{facets} |