canonical: https://jentic.com/apis/vtex.local/legacy-search-api

# Vtex Legacy Search API

> Check the new [Search onboarding guide](https://developers.vtex.com/docs/guides/search-overview). 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. The API exposes 15 endpoints secured with apiKey authentication.

## For AI agents

Programmatically get product search of who saw also saw (deprecated), get product search of who saw also bought (deprecated). Covers 15 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for e-commerce only.

## Capabilities

- Get product search of who saw also saw (deprecated)
- Manage e commerce data programmatically
- Integrate Legacy Search API into automated workflows
- Query and filter Legacy Search API records by parameters
- Monitor Legacy Search API operational status and events

## Use cases

### E-Commerce Operations

Use the Legacy Search API to perform e commerce operations programmatically. The API provides 15 endpoints covering core functionality including get product search of who saw also saw (deprecated), get product search of who saw also bought (deprecated), get product search of who bought also bought (deprecated).

Example prompt: Call GET `/api/catalog_system/pub/products/crossselling/whosawalsosaw/{productId}` to get product search of who saw also saw (deprecated)

### Automated CrossSelling Management

Automate crossselling operations by combining multiple Legacy Search API endpoints. Agents can get product search of who saw also bought (deprecated) and then get product search of who bought also bought (deprecated) in a single workflow.

Example prompt: Call GET `/api/catalog_system/pub/products/crossselling/whosawalsobought/{productId}` to get product search of who saw also bought (deprecated), then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Legacy Search API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'get product search of who saw also saw (deprecated)', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/catalog_system/pub/products/crossselling/whosawalsosaw/{productId}` | Get product search of who saw also saw (deprecated) |
| GET | `/api/catalog_system/pub/products/crossselling/whosawalsobought/{productId}` | Get product search of who saw also bought (deprecated) |
| GET | `/api/catalog_system/pub/products/crossselling/whoboughtalsobought/{productId}` | Get product search of who bought also bought (deprecated) |
| GET | `/api/catalog_system/pub/products/crossselling/showtogether/{productId}` | Get product search of show together |
| GET | `/api/catalog_system/pub/products/crossselling/accessories/{productId}` | Get product search of accessories |
| GET | `/api/catalog_system/pub/products/crossselling/similars/{productId}` | Get product search of similars |
| GET | `/api/catalog_system/pub/products/crossselling/suggestions/{productId}` | Get product search of suggestions |
| GET | `/api/catalog_system/pub/products/search/{search}` | Search for products |

## Key resources

- **CrossSelling** — Operations related to CrossSelling
- **Search** — Operations related to Search
- **Offers** — Operations related to Offers
- **Facets** — Operations related to Facets
- **Autocomplete** — Operations related to Autocomplete

## Why Jentic

- **Setup:** Wiring the VTEX Legacy Search API by hand means pairing an App Key with an App Token in the X-VTEX-API-AppKey and X-VTEX-API-AppToken headers, and templating the {accountName} and {environment} host into every call. Through Jentic you install once, import the Legacy Search API from the API Directory, store the App Key and App Token once, and your agent calls it.
- **Permission scoping:** The Legacy Search API puts the product id in the URL path (`/api/catalog_system/pub/products/crossselling/similars/{productId}`), so a rule can pin your agent to cross-selling lookups for one product. Every operation here reads catalog data, so you can limit the agent to search and cross-sell reads and nothing more.
- **Credential handling:** Your VTEX App Key and App Token are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'find products bought together with a product' or 'search the catalog by term', and Jentic returns the matching Legacy Search API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Shopify** — Alternative e commerce API
- **Stripe** — Alternative e commerce API

## FAQ

### What authentication does the Legacy Search API use?

The Legacy Search API uses an API key passed in the `X-VTEX-API-AppKey` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I get product search of who saw also saw (deprecated) with the Legacy Search API?

Yes. Use the GET `/api/catalog_system/pub/products/crossselling/whosawalsosaw/{productId}` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Legacy Search API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I get product search of who saw also saw (deprecated) through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get product search of who saw also saw (deprecated)'. Jentic returns the matching Legacy Search API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Legacy Search API have?

The Legacy Search API exposes 15 endpoints covering crossselling, search, offers operations.

### Can I limit what my agent is allowed to do with the Legacy Search API?

Yes. Because you run Jentic One yourself, your own rules decide which Legacy Search API operations and credentials the agent may use. Every operation here reads catalog data, so you can restrict the agent to search and cross-sell reads such as GET `/api/catalog_system/pub/products/crossselling/similars/{productId}` and nothing more. Since the product id sits in the URL path, a rule can even pin the agent to cross-selling lookups for a single product.