API Reference

Integration Guides
Search Protocol
Implementing a Custom Search Resolver App

Supposing you want to integrate another search provider into VTEX, here are the steps you should follow to create an app that follows the VTEX Search Protocol:

  1. Clone the VTEX Intelligent Search search resolver app:
  2. TEMPORARY: Uninstall any other search-resolver app that may be installed on the account you're using (e.g: You may need to do this in a separate workspace if the store is live
  3. Change the vendor field on the app's manifest.json to map the account you're using.
  4. Start changing the queries' resolvers implementations to retrieve and return the data from the external search engine you're integrating.


In VTEX IO, we have the concept of clients to abstract calling other services in a centralized class. If you've cloned the search resolver listed above, you will see that it grabs data by using the following client: Change the implementation of this client to fetch data from the search provider that you want to integrate with.


The main resolver file that you need to change is this You can look for occurrences of biggySearch and change the data treatment to get the wanted behavior. Remember that you may want to leave some resolvers untouched and continue grabbing data from VTEX Catalog's APIs.

Tips on Working with the Example

  • Entries and files with BiggySearchClient should be modified and renamed accordingly to the search engine to be integrated.
  • The main file to look at is node/resolvers/search/index.ts, where is implemented resolvers for search-related queries. It's important to notice that some resolvers will not be modified since they're connecting directly to VTEX APIs. This will be addressed on future releases of VTEX Search Protocol. You can find a list of all the queries to change the implementation in the specification section of this document.
  • It's important to adapt the Typescript types into the code, because they're specific to VTEX Search.


In case of any "Unknown errors", check if the version on node/package.json for the dependency is up to date with the latest version for the app. After changing the version on the URL, you need to run yarn inside the node folder before running vtex link again.

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