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

# Vtex SKU Bindings API

vtex.local/SKU-Bindings-API version 1.0. The API exposes 12 endpoints secured with apiKey authentication.

## For AI agents

Programmatically get sku bindings by sku id, get sku bindings information. Covers 12 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Get SKU Bindings by SKU ID
- Bind a seller's SKU to another SKU
- Change Notification with SKU ID
- Query and filter SKU Bindings API records by parameters
- Monitor SKU Bindings API operational status and events

## Use cases

### Developer Tools Operations

Use the SKU Bindings API to perform developer tools operations programmatically. The API provides 12 endpoints covering core functionality including get sku bindings by sku id, get sku bindings information, get details of a seller's sku.

Example prompt: Call GET `/catalog/pvt/skusellers/{skuId}` to get sku bindings by sku id

### Automated SKU Bindings Management

Automate sku bindings operations by combining multiple SKU Bindings API endpoints. Agents can get sku bindings information and then get details of a seller's sku in a single workflow.

Example prompt: Call GET `/sku-binding/pvt/skuseller/admin` to get sku bindings information, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call SKU Bindings 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 sku bindings by sku id', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/catalog/pvt/skusellers/{skuId}` | Get SKU Bindings by SKU ID |
| GET | `/sku-binding/pvt/skuseller/admin` | Get SKU Bindings information |
| GET | `/sku-binding/pvt/skuseller/{sellerId}/{sellerSkuId}` | Get details of a seller's SKU |
| PUT | `/sku-binding/pvt/skuseller/{sellerId}/{sellerSkuId}` | Bind a seller's SKU to another SKU |
| GET | `/sku-binding/pvt/skuseller/list/bysellerId/{sellerId}` | Get all SKU Bindings by Seller ID |
| GET | `/sku-binding/pvt/skuseller/paged/sellerid/{sellerId}` | Get paged SKU Bindings by Seller ID |
| POST | `/sku-binding/pvt/skuseller/changenotification/{skuId}` | Change Notification with SKU ID |
| POST | `/sku-binding/pvt/skuseller/changenotification/{sellerId}/{sellerSkuId}` | Change Notification with Seller ID and Seller SKU ID |

## Key resources

- **SKU Bindings** — Operations related to SKU Bindings

## Why Jentic

- **Setup:** Wiring the VTEX SKU Bindings 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 SKU Bindings API from the API Directory, store the App Key and App Token once, and your agent calls it.
- **Permission scoping:** The SKU Bindings API puts the seller id and seller SKU id in the URL path (`/sku-binding/pvt/skuseller/{sellerId}/{sellerSkuId}`), so a rule can pin your agent to one seller's SKU bindings. You choose the operations it may call, so writes like updating a binding or sending change notifications are not included unless you add them.
- **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 'get SKU bindings by SKU id' or 'list bindings for a seller', and Jentic returns the matching SKU Bindings API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the SKU Bindings API use?

The SKU Bindings 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 sku bindings by sku id with the SKU Bindings API?

Yes. Use the GET `/catalog/pvt/skusellers/{skuId}` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the SKU Bindings 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 sku bindings by sku id through Jentic?

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

### How many endpoints does the SKU Bindings API have?

The SKU Bindings API exposes 12 endpoints covering sku bindings operations.

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

Yes. Jentic One is self-hosted by you, so your own rules decide which SKU Bindings API operations and credentials the agent may use. You can grant only read calls like GET `/catalog/pvt/skusellers/{skuId}` or GET `/sku-binding/pvt/skuseller/{sellerId}/{sellerSkuId}` while withholding writes such as binding a seller's SKU (PUT) or POSTing change notifications. Because the seller id and seller SKU id sit in the URL path, a rule can also pin the agent to a single seller's bindings.
