VTEX

Legacy Search API

> Check the new [Search onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/search-onboarding). We created this guide to improve the onboarding…

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

> 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 15

CrossSelling

  • GETGet Product Search of Accessorieshttps://entelperu.DefaultParameterValue.com.br/api/catalog_system/pub/products/crossselling/accessories/api/catalog_system/pub/products/crossselling/accessories/:productIdRetrieves general information about the product's accessories.
  • GETGet Product Search of Show Togetherhttps://entelperu.DefaultParameterValue.com.br/api/catalog_system/pub/products/crossselling/accessories/api/catalog_system/pub/products/crossselling/showtogether/:productIdRetrieves general information about the products that are show together with the product in question.
  • GETGet Product Search of Similarshttp://example.com/.DefaultParameterValue.com.br/api/catalog_system/pub/products/crossselling/similars/:productIdRetrieves general information about related product searches.
  • GETGet Product Search of Suggestionshttp://example.com/.DefaultParameterValue.com.br/api/catalog_system/pub/products/crossselling/suggestions/:productIdRetrieves general information about other product suggestions related to the product.
  • GETGet Product Search of Who Bought Also Boughthttp://example.com/.DefaultParameterValue.com.br/api/catalog_system/pub/products/crossselling/whoboughtalsobought/:productIdRetrieves general information about other related products that the user also bought.
  • GETGet Product Search of Who Saw Also Boughthttp://example.com/.DefaultParameterValue.com.br/api/catalog_system/pub/products/crossselling/whosawalsobought/:productIdRetrieves general information about other related products that the users saw and also bought.
  • GETGet Product Search of Who Saw Also Sawhttp://example.com/.DefaultParameterValue.com.br/api/catalog_system/pub/products/crossselling/whosawalsosaw/:productIdRetrieves general information about other related products that the users also saw.

Search

  • GETSearch for Products with Filter, Order and Paginationhttp://example.com/.DefaultParameterValue.com.br/api/catalog_system/pub/products/search?_from=1&_to=50&ft=television&fq=C:/1000041/1000049/&O=OrderByNameASCRetrieves general information about the store products. This information can be filtered and ordered by a number of options. It also can be paginated,…
  • GETSearch Product by Product URLhttp://example.com/.DefaultParameterValue.com.br/api/catalog_system/pub/products/search/:product-text-link/pRetrieves general information about the product of the URL you searched for.
  • GETSearch for Productshttp://example.com/.DefaultParameterValue.com.br/api/catalog_system/pub/products/search/:searchRetrieves general information about the products related to the term searched. This is the main search used by the store. The user can type anything to be…

Offers

  • GETSearch Product offers/api/catalog_system/pub/products/offers/:productIdRetrieves existing offers of a specific product.
  • GETSearch SKU offers/api/catalog_system/pub/products/offers/:productId/sku/:skuIdRetrieves existing offers of a specific SKU.

Facets

  • GETGet Category Facets/api/catalog_system/pub/facets/category/:categoryId?_from=1&_to=50Retrieves the names and IDs of the categories facets. >⚠️ This endpoint returns a maximum of 50 items per response, so the difference between _from and _to…
  • GETSearch by Store Facets/api/catalog_system/pub/facets/search/:term?map=c&_from=1&_to=50Retrieves products by store facets. >⚠️ This endpoint returns a maximum of 50 items per response, so the difference between _from and _to should not exceed…

Autocomplete

  • GETProduct Search Autocompletehttp://example.com/.DefaultParameterValue.com.br/buscaautocomplete?productNameContains=jeansRetrieves product's information related to the searched string. {{searchString}} is the part of string the user is looking for. E.g.: ref | refrig |…

API details

Base URL
https://vtex.local
https://{accountName}.{environment}.com.br
Authentication
An API key in the X-VTEX-API-AppKey header
An API key in the X-VTEX-API-AppToken header
Operations
15 operations on 15 pathsGET 15
Main resources
CrossSelling 7Search 3Facets 2Offers 2Autocomplete 1
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 1.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Legacy 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 Legacy Search API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-VTEX-API-AppKey header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get Product Search of Accessories” (GET https://entelperu.DefaultParameterValue.com.br/api/catalog_system/pub/products/crossselling/accessories/api/catalog_system/pub/products/crossselling/accessories/:productId), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Legacy Search API?

> Check the new [Search onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/search-onboarding). We created this guide to improve the onboarding… It is listed under Other and has 15 endpoints.

Who publishes the Legacy 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 Legacy Search API?

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

How do I authenticate with the Legacy Search API?

It accepts 2 methods: an API key in the X-VTEX-API-AppKey header; an API key in the X-VTEX-API-AppToken header.

How many endpoints does the Legacy Search API have?

15 operations on 15 paths (15 GET). The largest groups are CrossSelling, Search, Facets, Offers.

Is forking the Legacy 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.