VTEX

Intelligent Search API

>ℹ️ Onboarding guide > > Check the new [Search onboarding guide](https://developers.vtex.com/docs/guides/search-overview). We created this guide to improve…

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

>ℹ️ 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

Endpoints 7

Autocomplete

  • GETGet list of suggested terms and attributes similar to the search term/autocomplete_suggestions?query=string&locale=en-USLists the suggested terms and attributes similar to the search term.
  • GETGet list of the 10 most searched terms/top_searches?locale=en-USLists the 10 most searched terms.

Product List Page

  • GETGet list of banners registered for query/banners/:facets?query=string&locale=en-USLists the banners registered for a given query. Check the configuring banners documentation for a full explanation of the banner feature.
  • GETGet attempt of correction of a misspelled term/correction_search?query=string&locale=en-USTries to correct a misspelled term from the search.
  • GETGet list of the possible facets for a given query/facets/:facets?query=string&locale=en-US&hideUnavailableItems=falseLists the possible facets for a given query
  • GETGet list of products for a query/product_search/:facets?query=string&simulationBehavior=default&count=24&page=1&sort=price:desc&locale=en-US&hideUnavailableItems=falseLists the products for a given query.
  • GETGet list of suggested terms similar to the search term/search_suggestions?query=string&locale=en-USLists suggested terms similar to the search term.

API details

Base URL
https://vtex.local
https://{accountName}.vtexcommercestable.com.br/api/io/_v/api/intelligent-search
Authentication
None declared in the description
Operations
7 operations on 7 pathsGET 7
Main resources
Product List Page 5Autocomplete 2
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 0.1.12
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Intelligent Search API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Intelligent Search API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Get list of suggested terms and attributes similar to the search term” (GET /autocomplete_suggestions?query=string&locale=en-US), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Intelligent Search API?

>ℹ️ Onboarding guide > > Check the new [Search onboarding guide](https://developers.vtex.com/docs/guides/search-overview). We created this guide to improve… It is listed under Other and has 7 endpoints.

Who publishes the Intelligent Search API?

It is listed from VTEX's public API description (an OpenAPI document), not published by VTEX on Swastik Codes. Anyone who controls vtex.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Intelligent Search API?

Its description lists 2 base URLs: https://vtex.local, https://{accountName}.vtexcommercestable.com.br/api/io/_v/api/intelligent-search. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Intelligent Search API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Intelligent Search API have?

7 operations on 7 paths (7 GET). The largest groups are Product List Page, Autocomplete.

Is forking the Intelligent Search API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.