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.

This API is from the VTEX Intelligent Search solution, an alternative to the platform’s native search, as it assists the customer in their purchase journey, and it presents results since the first interaction with the search bar.

Index

• Get list of the 10 most searched terms
• Get list of suggested terms and attributes similar to the search term
• Get attempt of correction of a misspelled term
• Get list of banners registered for query
• Get list of suggested terms similar to the search term
• Get list of products for a query
• Get list of the possible facets for a given query

Use this page to mock Intelligent Search API in your testing and development.

Run our mock API sample using the open source WireMock library, or in the free edition of WireMock Cloud. You'll have a working API server simulating the behavior of Intelligent Search API, which will allow you to keep building and testing even if the actual API you isn't currently available.