vtex.local

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

7 endpoints

📄 Docs 📋 OpenAPI spec 🔬 Try in Swagger UI

SDKs by language (10 total)

lever-sdk ✓ Official

npm install lever-sdk

GitHub integration →

ads-js ✓ Official

npm install ads-js

GitHub integration →

vtex-node-sdk

npm install vtex-node-sdk

GitHub integration →

physical-payments-sdk ✓ Official

# Maven: see https://github.com/vtex-apps/physical-payments-sdk

GitHub integration →

VTEX-SDK-dotnet

dotnet add package VTEX-SDK-dotnet

GitHub integration →

vtex-sdk

composer require vtex-sdk

GitHub integration →

vtex-sdk-php

composer require vtex-sdk-php

GitHub integration →

vtex-api

composer require vtex-api

GitHub integration →

vtex-kotlin-sdk

# See https://github.com/ksetoue/vtex-kotlin-sdk

GitHub integration →

vtex.js ✓ Official

# See https://github.com/vtex/vtex.js

GitHub integration →

curl examples

Get list of the 10 most searched terms

curl \
  https://vtex.local/top_searches

Get list of the possible facets for a given query

curl \
  https://vtex.local/facets/{facets}

Get list of banners registered for query

curl \
  https://vtex.local/banners/{facets}

Endpoints (7 total)

GET

/top_searches

Get list of the 10 most searched terms

GET

/facets/{facets}

Get list of the possible facets for a given query

GET

/banners/{facets}

Get list of banners registered for query

GET

/correction_search

Get attempt of correction of a misspelled term

GET

/search_suggestions

Get list of suggested terms similar to the search term

GET

/product_search/{facets}

Get list of products for a query

GET

/autocomplete_suggestions

Get list of suggested terms and attributes similar to the search term