API Reference

Getting started

Help us improve our documentation! Tell us about your experience with this article by filling out this form.

Intelligent Search is a VTEX IO alternative to Legacy Search. It assists the customer in their purchase journey and presents results from the first interaction with the search bar. The tool displays search and product suggestions that may interest the user. Intelligent Search also corrects spelling errors and understands words not contained in the product information.

The VTEX Search app is responsible for handling the new Intelligent Search solution in IO stores by providing new UI components that enhance the search experience, such as the autocomplete feature.


Intelligent Search API

The Intelligent Search API allows you to consult the information about the user's search in your store and its terms. You can also access information about banners, facets, and suggested terms.

Customizing the search experience of your store

Search Result

VTEX Search Result app is responsible for handling the result fetched by the Intelligent Search API and displaying it to users. The app exports all store blocks expected in a search results page, such as the filters and the product gallery.

{"base64":"  ","img":{"width":2878,"height":1578,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":746685,"url":""}}

The Search Bar component shows a search bar with autocomplete options and displays the matching products.

{"base64":"  ","img":{"width":1892,"height":694,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":884048,"url":""}}


The Autocomplete is an alternative for the default VTEX autocomplete. The functionality displays previous search results based on current and previous searches. These results are presented in four different lists, which can be together or separated, depending on the customer's interaction.

{"base64":"  ","img":{"width":1528,"height":692,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":320801,"url":""}}


Banners are the functionality responsible for displaying banners as promotional actions on the customer's search result page. This process is done by associating the words and filters selected when searching for these banners.


Suggestions is a component used to suggest search terms similar to the current query.


DidYouMean is a component used to suggest a possible misspelling correction to the current query.

Search Control

The Search Control control is responsible for generating the search box. Besides the search filed, the control renders a combo for restricting a search in one department.

Customizing the search result

You can provide your customers with a more customized experience navigating the search result. You may want to present custom search results for each customer or even engage your users with specific products through a URL.


Integrating an external search provider with VTEX

The Search Protocol defines the contract between an external search provider and a VTEX store running on VTEX IO. If a search provider adheres to this protocol, it can completely replace the original VTEX search capabilities without needing to implement any frontend pages or react components.

Integrating your search with Google services

You can integrate your store's search to some Google features, such as the Google Chrome language processing and Google Analytics. These integrations can help retailers analyze user queries, measure the store's main searched terms, and create a more accessible environment for customers.

Legacy Search allows you to query, search and sort products in the catalog using fulltext, category, and brand search terms.

Photo of the contributor
Photo of the contributor
Photo of the contributor
+ 3 contributors
Was this helpful?
Suggest edits (Github)
Photo of the contributor
Photo of the contributor
Photo of the contributor
+ 3 contributors
On this page