vtex.local – Intelligent-Search-API

OpenAPI apis-guru

ℹ️ Onboarding guide

Check the new . 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 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

Homepage: https://api.apis.guru/v2/specs/vtex.local:Intelligent-Search-API/0.1.12.json
Provider: vtex.local:Intelligent-Search-API / Intelligent-Search-API
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/vtex.local/Intelligent-Search-API/0.1.12/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/vtex.local/Intelligent-Search-API/0.1.12/openapi.yaml

Tools (9)

Extracted live via the executor SDK.

autocomplete.getAutocompleteSuggestions

Lists the suggested terms and attributes similar to the search term.
autocomplete.getTopSearches

Lists the 10 most searched terms.
productListPage.getBannersFacets

Lists the banners registered for a given query. Check the for a full explanation of the banner feature.
productListPage.getCorrectionSearch

Tries to correct a misspelled term from the search.
productListPage.getFacetsFacets

Lists the possible facets for a given query
productListPage.getProductSearchFacets

Lists the products for a given query.
productListPage.getSearchSuggestions

Lists suggested terms similar to the search term.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools