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 SKU API

The SKU API from VTEX — 10 operation(s) for sku.

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

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

This API exposes 12 operations across 10 paths, and defines 12 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

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

12 operations 10 paths 12 schemas 9 GET2 POST1 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 SKU 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 12

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

SKU 12
GET
/api/catalog-seller-portal/skus/_search
VTex Search for SKU
SearchSKU 6 params → 200
GET
/api/catalog-seller-portal/skus/ids
VTex Get List of SKUs
ListSKU 4 params → 200
GET
/api/catalog_system/pvt/sku/stockkeepingunitids
VTex List all SKU IDs
ListallSKUIDs 4 params → 200
GET
/api/catalog_system/pvt/sku/stockkeepingunitbyid/{skuId}
VTex Get SKU and context
SkuContext 4 params → 200
GET
/api/catalog/pvt/stockkeepingunit
VTex Get SKU by RefId
3 params → 200
POST
/api/catalog/pvt/stockkeepingunit
VTex Create SKU
2 params body → 200
GET
/api/catalog_system/pvt/sku/stockkeepingunitidbyrefid/{refId}
VTex Get SKU ID by reference ID
SkuIdbyRefId 3 params → 200
GET
/api/catalog_system/pvt/sku/stockkeepingunitbyalternateId/{alternateId}
VTex Get SKU by alternate ID
SkubyAlternateId 3 params → 200
GET
/api/catalog_system/pvt/sku/stockkeepingunitByProductId/{productId}
VTex Get SKU list by product ID
SkulistbyProductId 3 params → 200
POST
/api/catalog_system/pub/sku/stockkeepingunitidsbyrefids
VTex Retrieve SKU ID list by reference ID list
SkuIdlistbyRefIdlist 2 params body → 200500
GET
/api/catalog/pvt/stockkeepingunit/{skuId}
VTex Get SKU
Sku 3 params → 200
PUT
/api/catalog/pvt/stockkeepingunit/{skuId}
VTex Update SKU
3 params body → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are GetSKUAltID (56 properties), GetSKUandContext (51 properties), SkulistbyProductId (36 properties), Attachment (6 properties). Each schema is shown below with its type and property counts.

SkuSpecification
object
Object containing related SKU specifications.
4 properties 4 required
Image
object
Object containing SKU images details.
3 properties 3 required
SkuSeller
object
Object containing related SKU sellers data.
6 properties 6 required
GetSKUandContext
object
51 properties 42 required
Field
object
3 properties 3 required
SkulistbyProductId
object
36 properties
AlternateIds
object
Array with alternate SKU IDs, such as EAN and RefId.
2 properties
ProductSpecification
object
4 properties 4 required
Attachment
object
Object containing information about SKU attachments.
6 properties 6 required
GetSKUAltID
object
56 properties 42 required
Dimension
object
Object containing the SKU dimensions to be used on the shipping calculation.
5 properties 5 required
RealDimension
object
Object containing the real SKU dimensions, which appear in the product page.
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vtex-sku-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 SKU 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.