How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

VTEX Product API

The Product API from VTEX — 11 operation(s) for product.

VTEX Product API is one of 142 APIs that VTEX publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Product. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 14 operations across 11 paths. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against a single base URL, https://{providerApiEndpoint}.

14 operations 11 paths 0 schemas 9 GET2 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://{providerApiEndpoint}
Authentication
API Key
Resource Areas
1

Authentication & Security 1

VTEX Product API declares 1 security scheme for authenticating requests. An API key is passed in the header as VtexIdclientAutCookie (VtexIdclientAutCookie).

  • VtexIdclientAutCookie — [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.

Paths & Operations 14

Across 11 paths, the API surfaces 14 operations — 9 GET, 2 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Product 14
GET
/api/catalog-seller-portal/products/{productId}
VTex Get Product by ID
GetProduct 3 params → 200
PUT
/api/catalog-seller-portal/products/{productId}
VTex Update Product
PutProduct 3 params body → 204
GET
/api/catalog-seller-portal/products/{productId}/description
VTex Get Product Description by Product ID
GetProductDescription 3 params → 200
PUT
/api/catalog-seller-portal/products/{productId}/description
VTex Update Product Description by Product ID
PutProductDescription 3 params body → 204
GET
/api/catalog-seller-portal/products/{param}
VTex Get Product by external ID, SKU ID, SKU external ID or slug
GetProductQuery 3 params → 200
POST
/api/catalog-seller-portal/products
VTex Create Product
PostProduct 2 params body → 200204
GET
/api/catalog_system/pvt/products/GetProductAndSkuIds
VTex Get product and SKU IDs
ProductAndSkuIds 5 params → 200
GET
/api/catalog/pvt/product/{productId}
VTex Get product by ID
GetProductbyid 3 params → 200
PUT
/api/catalog/pvt/product/{productId}
VTex Update product
3 params body → 200
GET
/api/catalog_system/pvt/products/productget/{productId}
VTex Get product and its general context
ProductandTradePolicy 3 params → 200
GET
/api/catalog_system/pvt/products/productgetbyrefid/{refId}
VTex Get product by reference ID
ProductbyRefId 3 params → 200
GET
/api/catalog_system/pub/products/variations/{productId}
VTex Get product's SKUs by product ID
ProductVariations 3 params → 200
GET
/api/addon/pvt/review/GetProductRate/{productId}
VTex Get product review rate by product ID
3 params → 200
POST
/api/catalog/pvt/product
VTex Create product with category and brand
2 params body → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vtex-product-api-openapi.yml Raw ↑

Other APIs VTEX publishes across the network.

VTEX Account API
VTEX Addresses API
VTEX Anti-Fraud Flow API
VTEX App Keys API
VTEX Attachment API
VTEX Authentication API
VTEX Autocomplete API
VTEX Brand API
VTEX Bulk Import API
VTEX Carriers API
VTEX Cart Attachments API
VTEX Category API
Where this information came from

This is an independent, third-party profile of VTEX Product API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.