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

# Vtex Catalog API - Seller Portal

With the Catalog API for Seller Portal, you will be able to create, edit and consult products and their variations, brands, and categories. >ℹ️ This API is part of the [Seller Portal Catalog](https://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp). This functionality is in the beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will no. The API exposes 16 endpoints secured with apiKey authentication.

## For AI agents

Programmatically get product by id, update product. Covers 16 operations with apiKey authentication.

## Scope

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

## Capabilities

- Get product by ID
- Update product
- Create product
- Search for SKU
- Monitor Catalog API - Seller Portal operational status and events

## Use cases

### E-Commerce Operations

Use the Catalog API - Seller Portal to perform e commerce operations programmatically. The API provides 16 endpoints covering core functionality including get product by id, update product, get product description by product id.

Example prompt: Call GET `/api/catalog-seller-portal/products/{productId}` to get product by id

### Automated Product Management

Automate product operations by combining multiple Catalog API - Seller Portal endpoints. Agents can update product and then get product description by product id in a single workflow.

Example prompt: Call PUT `/api/catalog-seller-portal/products/{productId}` to update product, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Catalog API - Seller Portal 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 by id', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/catalog-seller-portal/products/{productId}` | Get product by ID |
| PUT | `/api/catalog-seller-portal/products/{productId}` | Update product |
| GET | `/api/catalog-seller-portal/products/{productId}/description` | Get product description by product ID |
| PUT | `/api/catalog-seller-portal/products/{productId}/description` | Update product description by product ID |
| GET | `/api/catalog-seller-portal/products/{param}` | Get product by external ID, SKU ID, SKU external ID or slug |
| POST | `/api/catalog-seller-portal/products` | Create product |
| GET | `/api/catalog-seller-portal/skus/_search` | Search for SKU |
| GET | `/api/catalog-seller-portal/skus/ids` | Get list of SKUs |

## Key resources

- **Product** — Operations related to Product
- **SKU** — Operations related to SKU
- **Brand** — Operations related to Brand
- **Category** — Operations related to Category

## Why Jentic

- **Setup:** Wiring the VTEX Catalog Seller Portal 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 - Seller Portal from the API Directory, store the key pair once, and your agent calls it.
- **Permission scoping:** The Catalog Seller Portal API puts the product id in the URL path (`/products/{productId}`), so a rule can pin your agent to reading one product and its description. 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 a product' or 'search SKUs', and Jentic returns the matching Catalog Seller Portal 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 - Seller Portal use?

The Catalog API - Seller Portal 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 by id with the Catalog API - Seller Portal?

Yes. Use the GET `/api/catalog-seller-portal/products/{productId}` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Catalog API - Seller Portal?

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 by id through Jentic?

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

### How many endpoints does the Catalog API - Seller Portal have?

The Catalog API - Seller Portal exposes 16 endpoints covering product, sku, brand operations.

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

Yes. Because you run Jentic One yourself, you decide which Catalog API - Seller Portal operations your agent may call and which credentials it uses. Since this API puts the product id in the URL path, you can pin the agent to reading a single product and its description through GET `/api/catalog-seller-portal/products/{productId}.` Write operations such as the product update PUT are excluded unless you explicitly add them to the agent's allowed set.