Legacy Search API
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 lets you search and sort products in the Catalog using Fulltext, Category and Brand search terms.
Retrieve product data to create custom searches and product shelves.
Endpoints
CrossSelling
| Summary | Method | Path |
|---|---|---|
| Get product search of who saw also saw | GET | /api/catalog_system/pub/products/crossselling/whosawalsosaw/{productId} |
| Get product search of who saw also bought | GET | /api/catalog_system/pub/products/crossselling/whosawalsobought/{productId} |
| Get product search of who bought also bought | GET | /api/catalog_system/pub/products/crossselling/whoboughtalsobought/{productId} |
| Get product search of show together | GET | /api/catalog_system/pub/products/crossselling/showtogether/{productId} |
| Get product search of accessories | GET | /api/catalog_system/pub/products/crossselling/accessories/{productId} |
| Get product search of similars | GET | /api/catalog_system/pub/products/crossselling/similars/{productId} |
| Get product search of suggestions | GET | /api/catalog_system/pub/products/crossselling/suggestions/{productId} |
Search
| Summary | Method | Path |
|---|---|---|
| Search for products | GET | /api/catalog_system/pub/products/search/{search} |
| Search for products with filter, order and pagination | GET | /api/catalog_system/pub/products/search |
| Search product by product URL | GET | /api/catalog_system/pub/products/search/{product-text-link}/p |
Offers
| Summary | Method | Path |
|---|---|---|
| Search product offers | GET | /api/catalog_system/pub/products/offers/{productId} |
| Search SKU offers | GET | /api/catalog_system/pub/products/offers/{productId}/sku/{skuId} |
Facets
| Summary | Method | Path |
|---|---|---|
| Get category facets | GET | /api/catalog_system/pub/facets/category/{categoryId} |
| Search by store facets | GET | /api/catalog_system/pub/facets/search/{term} |
Autocomplete
| Summary | Method | Path |
|---|---|---|
| Product search autocomplete | GET | /buscaautocomplete |