Catalog API - Seller Portal

Name: Catalog API - Seller Portal API
Brand: Catalog API - Seller Portal
Availability: InStock

★ Only Publicly Available OpenAPI DocumentE CommerceStorefrontapiKey16 EndpointsREST

For Agents

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

Connect the Catalog API - Seller Portal to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Catalog API - Seller Portal, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Catalog API - Seller Portal API.

Get product by ID

Update product

Create product

Search for SKU

Monitor Catalog API - Seller Portal operational status and events

GET STARTED

Start building with Catalog API - Seller Portal API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for Catalog API - Seller Portal, keeping it validated and agent-ready.

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.

Use Cases

Patterns agents use Catalog API - Seller Portal API for, with concrete tasks.

★ 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.

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.

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.

Search Jentic for 'get product by id', load the operation schema, and execute with Jentic-managed credentials

Key Endpoints

16 endpoints — with the catalog api for seller portal, you will be able to create, edit and consult products and their variations, brands, and categories.

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

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

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Catalog API - Seller Portal apiKey credentials are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped access tokens — raw secrets never enter the agent context.

Intent-based discovery

Agents search by intent (e.g., 'get product by id') and Jentic returns the matching Catalog API - Seller Portal operation with its input schema, so the agent can call the right endpoint without browsing docs.

Time to first call

Direct Catalog API - Seller Portal integration: 1-3 days for auth handling, response parsing, and error cases. Through Jentic: under 1 hour — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Shopify

Alternative e commerce API

Choose Shopify when you need a different approach to e commerce operations

Alternative

Stripe

Alternative e commerce API

Choose Stripe when you need a different approach to e commerce operations

FAQs

Specific to using Catalog API - Seller Portal API through Jentic.

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 the MAXsystem vault 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 at https://app.jentic.com/sign-up, 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.