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

# Vtex Catalog API

> Check the new [Catalog onboarding guide](https://developers.vtex.com/docs/guides/catalog-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey. The Catalog API is a crucial part of the VTEX ecommerce platform, empowering developers t. The API exposes 162 endpoints secured with apiKey authentication.

## For AI agents

Programmatically get product and sku ids, get product by id. Covers 162 operations with apiKey authentication.

## Scope

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

## Capabilities

- Get product and SKU IDs
- Update product
- Integrate Catalog API into automated workflows
- Query and filter Catalog API records by parameters
- Monitor Catalog API operational status and events

## Use cases

### E-Commerce Operations

Use the Catalog API to perform e commerce operations programmatically. The API provides 162 endpoints covering core functionality including get product and sku ids, get product by id, update product.

Example prompt: Call GET `/api/catalog_system/pvt/products/GetProductAndSkuIds` to get product and sku ids

### Automated SKU service Management

Automate sku service operations by combining multiple Catalog API endpoints. Agents can get product by id and then update product in a single workflow.

Example prompt: Call GET `/api/catalog/pvt/product/{productId}` to get product by id, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Catalog 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 and sku ids', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/catalog_system/pvt/products/GetProductAndSkuIds` | Get product and SKU IDs |
| GET | `/api/catalog/pvt/product/{productId}` | Get product by ID |
| PUT | `/api/catalog/pvt/product/{productId}` | Update product |
| GET | `/api/catalog_system/pvt/products/productget/{productId}` | Get product and its general context |
| GET | `/api/catalog_system/pvt/products/productgetbyrefid/{refId}` | Get product by reference ID |
| GET | `/api/catalog_system/pub/products/variations/{productId}` | Get product's SKUs by product ID |
| GET | `/api/addon/pvt/review/GetProductRate/{productId}` | Get product review rate by product ID |
| POST | `/api/catalog/pvt/product` | Create product with category and brand |

## Key resources

- **SKU service** — Operations related to SKU service
- **SKU service attachment** — Operations related to SKU service attachment
- **SKU service value** — Operations related to SKU service value
- **SKU service type** — Operations related to SKU service type
- **Category** — Operations related to Category

## Why Jentic

- **Setup:** Wiring the VTEX Catalog API by hand means setting both the X-VTEX-API-AppKey and X-VTEX-API-AppToken headers, resolving the account and environment host template, and managing the product and SKU calls yourself. Through Jentic you install once, import the Catalog API from the API Directory, store the key pair once, and your agent calls it.
- **Permission scoping:** The Catalog API puts the product id in the URL path (`/api/catalog/pvt/product/{productId}`), so a rule can pin your agent to reading one product. You choose the operations it may call, so updates via the product PUT are not included unless you add them.
- **Credential handling:** Your VTEX AppKey and AppToken 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 'get product and SKU ids' or 'read a product', and Jentic returns the matching Catalog 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 Catalog API use?

The Catalog 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 and sku ids with the Catalog API?

Yes. Use the GET `/api/catalog_system/pvt/products/GetProductAndSkuIds` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Catalog 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 and sku ids through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get product and sku ids'. Jentic returns the matching Catalog API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Catalog API have?

The Catalog API exposes 162 endpoints covering sku service, sku service attachment, sku service value operations.

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

Yes. Because you self-host Jentic One, your own rules decide which Catalog API operations and credentials your agent may use. Since the product ID sits in the URL path (`/api/catalog/pvt/product/{productId}`), you can pin the agent to reading a single product and expose only the read operations you approve, such as GetProductAndSkuIds or get product by ID. Write operations like the PUT that updates a product stay off-limits unless you explicitly add them.