Intelligent Search API
Onboarding guide
Check the new Search onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Search and is organized by focusing on the developer's journey.
VTEX Intelligent Search is a search solution for digital commerce that simply and intuitively displays relevant results based on the catalog from the user's first interaction with the store through the search bar, browsing categories, or even through the window displays.
The tool also offers features such as autocomplete, displaying search and product suggestions based on the shopper's context, and filters that help when searching for the desired product.
VTEX Intelligent Search is an alternative to VTEX search.
Index
Autocomplete
GETGet list of the 10 most searched termsGETGet list of suggested terms and attributes similar to the search termGETGet list of suggested terms similar to the search term
Product list page
GETGet attempt of correction of a misspelled termGETGet list of banners registered for queryGETGet list of products for a queryGETGet list of the possible facets for a given query
Delivery Promise
Common parameters
| Parameter name | Description |
|---|---|
{{accountName}} |
Name of the VTEX account. Used as part of the URL. |
{{environment}} |
Environment to use. Used as part of the URL. |
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} |
| Get list of products for a query | GET | /product_search/{facets} |
| Get list of the possible facets for a given query | GET | /facets/{facets} |
Delivery Promise
| Summary | Method | Path |
|---|---|---|
| Get pickup point availability for Delivery Promise | GET | /pickup-point-availability/{facets} |