APIHub
Back to Explore

Catalog API

> Check the new [Catalog onboarding guide](https://developers.vtex.com/docs/guides/catalog-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey. Methods for collecting product/SKU catalog data, categories, brands and other information

Uncategorized
apiKeyHeader
HTTPS
CORS: Unknown
Visit official documentation

Latency

3251ms p95

Uptime

0.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
POST

/api/catalog/pvt/collection

Create Collection

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
GET

/api/addon/pvt/giftlist/get/{listId}

Get Gift List

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • listId (path, required) — Gift List unique numerical identifier.
GET

/api/addon/pvt/review/GetProductRate/{productId}

Get Product Review Rate by Product ID

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • productId (path, required) — Product’s unique numerical identifier.
POST

/api/catalog/pvt/attachment

Create attachment

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
DELETE

/api/catalog/pvt/attachment/{attachmentid}

Delete attachment

  • attachmentid (path, required) — Attachment ID.
  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
GET

/api/catalog/pvt/attachment/{attachmentid}

Get attachment

  • attachmentid (path, required) — Attachment ID.
  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
PUT

/api/catalog/pvt/category/{categoryId}

Update Category

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • categoryId (path, required) — Category’s unique numerical identifier.
PUT

/api/catalog/pvt/attachment/{attachmentid}

Update attachment

  • attachmentid (path, required) — Attachment ID.
  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
GET

/api/catalog/pvt/attachments

Get all attachments

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
POST

/api/catalog/pvt/brand

Create Brand

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
DELETE

/api/catalog/pvt/brand/{brandId}

Delete Brand

  • brandId (path, required) — Brand’s unique numerical identifier.
  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
GET

/api/catalog/pvt/brand/{brandId}

Get Brand and context

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • brandId (path, required) — Brand ID.
PUT

/api/catalog/pvt/brand/{brandId}

Update Brand

  • brandId (path, required) — Brand’s unique numerical identifier.
  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
POST

/api/catalog/pvt/category

Create Category

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
GET

/api/catalog/pvt/category/{categoryId}

Get Category by ID

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • categoryId (path, required) — Category’s unique numerical identifier.
POST

/api/catalog/pvt/collection/

Create Collection

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
GET

/api/catalog/pvt/collection/inactive

Get All Inactive Collections

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
GET

/api/catalog/pvt/collection/stockkeepingunit/importfileexample

Import Collection file example

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
DELETE

/api/catalog/pvt/collection/{collectionId}

Delete Collection

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • collectionId (path, required) — Collection’s unique numerical identifier.
GET

/api/catalog/pvt/collection/{collectionId}

Get Collection

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • collectionId (path, required) — Collection’s unique numerical identifier.
PUT

/api/catalog/pvt/collection/{collectionId}

Update Collection

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • collectionId (path, required) — Collection’s unique numerical identifier.
POST

/api/catalog/pvt/collection/{collectionId}/position

Reposition SKU on the Subcollection

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • collectionId (path, required) — Collection’s unique numerical identifier.
GET

/api/catalog/pvt/collection/{collectionId}/products

Get products from a collection

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • collectionId (path, required) — Collection's unique identifier.
  • page (query, page) — Page number.
  • pageSize (query, limit) — Number of the items of the page.
  • Filter (query) — Filter used to refine the Collection's products.
  • Active (query) — Defines if the status of the product is active or not.
  • Visible (query) — Defines if the product is visible on the store or not.
  • CategoryId (query) — Product's Category unique identifier.
  • BrandId (query) — Product's Brand unique identifier.
  • SupplierId (query) — Product's Supplier unique identifier.
  • SalesChannelId (query) — Product's Trade Policy unique identifier.
  • ReleaseFrom (query) — Product past release date.
  • ReleaseTo (query) — Product future release date.
  • SpecificationProduct (query) — Product Specification Field Value. You must also fill in `SpecificationFieldId` to use this parameter.
  • SpecificationFieldId (query) — Product Specification Field unique identifier.
POST

/api/catalog/pvt/collection/{collectionId}/stockkeepingunit/importexclude

Remove products from Collection by imported file

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • collectionId (path, required) — Collection's unique identifier.
POST

/api/catalog/pvt/collection/{collectionId}/stockkeepingunit/importinsert

Add products to Collection by imported file

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • collectionId (path, required) — Collection's unique identifier.
GET

/api/catalog/pvt/collection/{collectionId}/subcollection

Get Subcollection by Collection ID

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • collectionId (path, required) — Collection’s unique numerical identifier.
DELETE

/api/catalog/pvt/product/{productId}/similarcategory/{categoryId}

Delete Similar Category

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • productId (path, required) — Product’s unique numerical identifier.
  • categoryId (path, required) — Similar Category’s unique numerical identifier.
POST

/api/catalog/pvt/product

Create Product with Category and Brand

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
GET

/api/catalog/pvt/product/{productId}

Get Product by ID

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • productId (path, required) — Product’s unique numerical identifier.
PUT

/api/catalog/pvt/product/{productId}

Update Product

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • productId (path, required) — Product’s unique numerical identifier.
GET

/api/catalog/pvt/product/{productId}/salespolicy

Get Trade Policies by Product ID

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • productId (path, required) — Product’s unique numerical identifier.
DELETE

/api/catalog/pvt/product/{productId}/salespolicy/{tradepolicyId}

Remove Product from Trade Policy

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • productId (path, required) — Product’s unique numerical identifier.
  • tradepolicyId (path, required) — Trade Policy’s unique numerical identifier.
POST

/api/catalog/pvt/product/{productId}/salespolicy/{tradepolicyId}

Associate Product with Trade Policy

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • productId (path, required) — Product’s unique numerical identifier.
  • tradepolicyId (path, required) — Trade Policy’s unique numerical identifier.
GET

/api/catalog/pvt/product/{productId}/similarcategory/

Get Similar Categories

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • productId (path, required) — Product’s unique numerical identifier.
POST

/api/catalog/pvt/product/{productId}/similarcategory/{categoryId}

Add Similar Category

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • productId (path, required) — Product’s unique numerical identifier.
  • categoryId (path, required) — Similar Category’s unique numerical identifier.
DELETE

/api/catalog/pvt/product/{productId}/specification

Delete all Product Specifications by Product ID

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • productId (path, required) — Product’s unique numerical identifier.
GET

/api/catalog/pvt/product/{productId}/specification

Get Product Specification and its information by Product ID

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • productId (path, required) — Product’s unique numerical identifier.
POST

/api/catalog/pvt/product/{productId}/specification

Associate Product Specification

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • productId (path, required) — Product’s unique numerical identifier.
DELETE

/api/catalog/pvt/product/{productId}/specification/{specificationId}

Delete a specific Product Specification

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • productId (path, required) — Product’s unique numerical identifier.
  • specificationId (path, required) — Product Specification’s unique numerical identifier.
PUT

/api/catalog/pvt/product/{productId}/specificationvalue

Associate product specification using specification name and group name

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • productId (path, required) — Product’s unique numerical identifier.
DELETE

/api/catalog/pvt/skuattachment

Dissociate attachments and SKUs

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (query) — SKU ID. By using this query param, you can dissociate all the attachments from an SKU based on its SKU ID.
  • attachmentId (query) — Attachment ID. By using this query param, you can dissociate the given attachment from all previously associated SKUs.
POST

/api/catalog/pvt/skuattachment

Associate SKU Attachment

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
DELETE

/api/catalog/pvt/skuattachment/{skuAttachmentAssociationId}

Delete SKU Attachment by Attachment Association ID

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuAttachmentAssociationId (path, required) — ID of the association between the attachment and the SKU, which corresponds to the `Id` in the response body of the [Associate SKU Attachment](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-post-sku-attachment) and the [Get SKU Attachment by SKU ID](https://developers.vtex.com/vtex-rest-api/reference/get_api-catalog-pvt-stockkeepingunit-skuid-attachment) endpoints.
POST

/api/catalog/pvt/skucomplement

Create SKU Complement

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
DELETE

/api/catalog/pvt/skucomplement/{skuComplementId}

Delete SKU Complement by SKU Complement ID

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuComplementId (path, required) — SKU Complement’s unique numerical identifier.
GET

/api/catalog/pvt/skucomplement/{skuComplementId}

Get SKU Complement by SKU Complement ID

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuComplementId (path, required) — SKU Complement’s unique numerical identifier.
POST

/api/catalog/pvt/skuservice

Associate SKU Service

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
DELETE

/api/catalog/pvt/skuservice/{skuServiceId}

Dissociate SKU Service

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuServiceId (path, required) — SKU Service unique identifier.
GET

/api/catalog/pvt/skuservice/{skuServiceId}

Get SKU Service

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuServiceId (path, required) — SKU Service unique identifier.
PUT

/api/catalog/pvt/skuservice/{skuServiceId}

Update SKU Service

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuServiceId (path, required) — SKU Service unique identifier.
POST

/api/catalog/pvt/skuservicetype

Create SKU Service Type

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
DELETE

/api/catalog/pvt/skuservicetype/{skuServiceTypeId}

Delete SKU Service Type

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuServiceTypeId (path, required) — SKU Service Type unique identifier.
GET

/api/catalog/pvt/skuservicetype/{skuServiceTypeId}

Get SKU Service Type

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuServiceTypeId (path, required) — SKU Service Type unique identifier.
PUT

/api/catalog/pvt/skuservicetype/{skuServiceTypeId}

Update SKU Service Type

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuServiceTypeId (path, required) — SKU Service Type unique identifier.
DELETE

/api/catalog/pvt/skuservicetypeattachment

Dissociate Attachment by Attachment ID or SKU Service Type ID

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • attachmentId (query) — SKU Service Attachment unique identifier.
  • skuServiceTypeId (query) — SKU Service Type unique identifier.
POST

/api/catalog/pvt/skuservicetypeattachment

Associate SKU Service Attachment

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
DELETE

/api/catalog/pvt/skuservicetypeattachment/{skuServiceTypeAttachmentId}

Dissociate Attachment from SKU Service Type

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuServiceTypeAttachmentId (path, required) — SKU Service Attachment unique identifier.
POST

/api/catalog/pvt/skuservicevalue

Create SKU Service Value

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
DELETE

/api/catalog/pvt/skuservicevalue/{skuServiceValueId}

Delete SKU Service Value

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuServiceValueId (path, required) — SKU Service Value unique identifier.
GET

/api/catalog/pvt/skuservicevalue/{skuServiceValueId}

Get SKU Service Value

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuServiceValueId (path, required) — SKU Service Value unique identifier.
PUT

/api/catalog/pvt/skuservicevalue/{skuServiceValueId}

Update SKU Service Value

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuServiceValueId (path, required) — SKU Service Value unique identifier.
POST

/api/catalog/pvt/specification

Create Specification

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
DELETE

/api/catalog/pvt/specification/nonstructured

Delete Non Structured Specification by SKU ID

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (query, required) — SKU’s unique numerical identifier.
GET

/api/catalog/pvt/specification/nonstructured

Get Non Structured Specification by SKU ID

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (query, required) — SKU’s unique numerical identifier.
DELETE

/api/catalog/pvt/specification/nonstructured/{Id}

Delete Non Structured Specification

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • Id (path, required) — Non Structured Specification’s unique numerical identifier.
GET

/api/catalog/pvt/specification/nonstructured/{Id}

Get Non Structured Specification by ID

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • Id (path, required) — Non Structured Specification’s unique numerical identifier.
GET

/api/catalog/pvt/stockkeepingunit/{skuId}/ean

Get EAN by SKU ID

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (path, required) — SKU’s unique numerical identifier.
GET

/api/catalog/pvt/specification/{specificationId}

Get Specification

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • specificationId (path, required) — Specification’s unique numerical identifier.
PUT

/api/catalog/pvt/specification/{specificationId}

Update Specification

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • specificationId (path, required) — Specification’s unique numerical identifier.
POST

/api/catalog/pvt/specificationgroup

Create Specification Group

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
PUT

/api/catalog/pvt/specificationgroup/{groupId}

Update Specification Group

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • groupId (path, required) — Group’s unique numerical identifier.
POST

/api/catalog/pvt/specificationvalue

Create Specification Value

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
GET

/api/catalog/pvt/specificationvalue/{specificationValueId}

Get Specification Value

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • specificationValueId (path, required) — Specification Value’s unique numerical identifier.
PUT

/api/catalog/pvt/specificationvalue/{specificationValueId}

Update Specification Value

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • specificationValueId (path, required) — Specification Value’s unique numerical identifier.
GET

/api/catalog/pvt/stockkeepingunit

Get SKU by RefId

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • refId (query, required) — SKU Reference ID.
POST

/api/catalog/pvt/stockkeepingunit

Create SKU

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
PUT

/api/catalog/pvt/stockkeepingunit/copy/{skuIdfrom}/{skuIdto}/file/

Copy Files from an SKU to another SKU

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuIdfrom (path, required) — __Origin__ SKU’s unique numerical identifier.
  • skuIdto (path, required) — __Target__ SKU’s unique numerical identifier.
DELETE

/api/catalog/pvt/stockkeepingunit/disassociate/{skuId}/file/{skuFileId}

Disassociate SKU File

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (path, required) — SKU’s unique numerical identifier.
  • skuFileId (path, required) — ID of the association of the SKU and the image, which can be obtained by placing a request to the [Get SKU File](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-sku-file) endpoint and copying the `Id` field.
GET

/api/catalog/pvt/stockkeepingunit/{skuId}

Get SKU

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (path, required) — SKU unique identifier number.
PUT

/api/catalog/pvt/stockkeepingunit/{skuId}

Update SKU

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (path, required) — SKU’s unique numerical identifier.
GET

/api/catalog/pvt/stockkeepingunit/{skuId}/attachment

Get SKU Attachments by SKU ID

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (path, required) — SKU unique identifier.
GET

/api/catalog/pvt/stockkeepingunit/{skuId}/complement

Get SKU Complement by SKU ID

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (path, required) — SKU’s unique numerical identifier.
GET

/api/catalog/pvt/stockkeepingunit/{skuId}/complement/{complementTypeId}

Get SKU Complements by Complement Type ID

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (path, required) — ID of the SKU which will be inserted as a Complement in the Parent SKU.
  • complementTypeId (path, required) — Complement Type ID. This represents the type of the complement. The possible values are: `1` for Accessory; `2` for Suggestion; `3` for Similar Product; `5` for Show Together.
DELETE

/api/catalog/pvt/stockkeepingunit/{skuId}/ean

Delete all SKU EAN values

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (path, required) — SKU’s unique numerical identifier.
DELETE

/api/catalog/pvt/stockkeepingunit/{skuId}/ean/{ean}

Delete SKU EAN

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (path, required) — SKU’s unique numerical identifier.
  • ean (path, required) — EAN number.
POST

/api/catalog/pvt/stockkeepingunit/{skuId}/ean/{ean}

Create SKU EAN

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (path, required) — SKU’s unique numerical identifier.
  • ean (path, required) — EAN.
DELETE

/api/catalog/pvt/stockkeepingunit/{skuId}/file

Delete All SKU Files

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (path, required) — SKU’s unique numerical identifier.
GET

/api/catalog/pvt/stockkeepingunit/{skuId}/file

Get SKU Files

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (path, required) — SKU’s unique numerical identifier.
POST

/api/catalog/pvt/stockkeepingunit/{skuId}/file

Create SKU File

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (path, required) — SKU’s unique numerical identifier.
DELETE

/api/catalog/pvt/stockkeepingunit/{skuId}/file/{skuFileId}

Delete SKU Image File

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (path, required) — SKU’s unique numerical identifier.
  • skuFileId (path, required) — ID of the association of the SKU and the image, which can be obtained by placing a request to the [Get SKU File](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-sku-file) endpoint and copying the `Id` field.
PUT

/api/catalog/pvt/stockkeepingunit/{skuId}/file/{skuFileId}

Update SKU File

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (path, required) — SKU’s unique numerical identifier.
  • skuFileId (path, required) — ID of the association of the SKU and the image, which can be obtained by placing a request to the [Get SKU File](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-sku-file) endpoint and copying the `Id` field.
DELETE

/api/catalog/pvt/stockkeepingunit/{skuId}/specification

Delete all SKU Specifications

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (path, required) — SKU’s unique numerical identifier.
GET

/api/catalog/pvt/stockkeepingunit/{skuId}/specification

Get SKU Specifications

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (path, required) — SKU’s unique numerical identifier.
POST

/api/catalog/pvt/stockkeepingunit/{skuId}/specification

Associate SKU Specification

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (path, required) — SKU’s unique numerical identifier.
PUT

/api/catalog/pvt/stockkeepingunit/{skuId}/specification

Update SKU Specification

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (path, required) — SKU’s unique numerical identifier.
DELETE

/api/catalog/pvt/stockkeepingunit/{skuId}/specification/{specificationId}

Delete SKU Specification

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (path, required) — SKU’s unique numerical identifier.
  • specificationId (path, required) — Specification’s unique numerical identifier.
PUT

/api/catalog/pvt/stockkeepingunit/{skuId}/specificationvalue

Associate SKU specification using specification name and group name

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (path, required) — SKU’s unique numerical identifier.
DELETE

/api/catalog/pvt/stockkeepingunitkit

Delete SKU Kit by SKU ID or Parent SKU ID

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (query) — SKU’s unique numerical identifier.
  • parentSkuId (query) — Parent SKU’s unique numerical identifier.
GET

/api/catalog/pvt/stockkeepingunitkit

Get SKU Kit by SKU ID or Parent SKU ID

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (query) — SKU’s unique numerical identifier.
  • parentSkuId (query) — Parent SKU’s unique numerical identifier.
POST

/api/catalog/pvt/stockkeepingunitkit

Create SKU Kit

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
DELETE

/api/catalog/pvt/stockkeepingunitkit/{kitId}

Delete SKU Kit by KitId

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • kitId (path, required) — Kit’s unique numerical identifier.
GET

/api/catalog/pvt/stockkeepingunitkit/{kitId}

Get SKU Kit

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • kitId (path, required) — Kit’s unique numerical identifier
POST

/api/catalog/pvt/subcollection

Create Subcollection

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
DELETE

/api/catalog/pvt/subcollection/{subCollectionId}

Delete Subcollection

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • subCollectionId (path, required) — Subcollection’s unique numerical identifier, which can be obtained by placing a request to [Get Subcollection by Collection ID](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-subcollection-collectionid).
GET

/api/catalog/pvt/subcollection/{subCollectionId}

Get Subcollection

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • subCollectionId (path, required) — Subcollection’s unique numerical identifier, which can be obtained by placing a request to [Get Subcollection by Collection ID](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-subcollection-collectionid).
PUT

/api/catalog/pvt/subcollection/{subCollectionId}

Update Subcollection

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • subCollectionId (path, required) — Subcollection’s unique numerical identifier, which can be obtained by placing a request to [Get Subcollection by Collection ID](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-subcollection-collectionid).
POST

/api/catalog/pvt/subcollection/{subCollectionId}/brand

Associate Brand to Subcollection

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • subCollectionId (path, required) — Subcollection’s unique numerical identifier, which can be obtained by placing a request to [Get Subcollection by Collection ID](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-subcollection-collectionid).
DELETE

/api/catalog/pvt/subcollection/{subCollectionId}/brand/{brandId}

Delete Brand from Subcollection

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • subCollectionId (path, required) — Subcollection’s unique numerical identifier, which can be obtained by placing a request to [Get Subcollection by Collection ID](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-subcollection-collectionid).
  • brandId (path, required) — Brand’s unique numerical identifier.
DELETE

/api/catalog/pvt/subcollection/{subCollectionId}/brand/{categoryId}

Delete Category from Subcollection

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • subCollectionId (path, required) — Subcollection’s unique numerical identifier, which can be obtained by placing a request to [Get Subcollection by Collection ID](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-subcollection-collectionid).
  • categoryId (path, required) — Category’s unique numerical identifier.
POST

/api/catalog/pvt/subcollection/{subCollectionId}/category

Associate Category to Subcollection

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • subCollectionId (path, required) — Subcollection’s unique numerical identifier, which can be obtained by placing a request to [Get Subcollection by Collection ID](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-subcollection-collectionid).
POST

/api/catalog/pvt/subcollection/{subCollectionId}/stockkeepingunit

Add SKU to Subcollection

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • subCollectionId (path, required) — Subcollection’s unique numerical identifier, which can be obtained by placing a request to [Get Subcollection by Collection ID](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-subcollection-collectionid).
DELETE

/api/catalog/pvt/subcollection/{subCollectionId}/stockkeepingunit/{skuId}

Delete SKU from Subcollection

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • subCollectionId (path, required) — Subcollection’s unique numerical identifier, which can be obtained by placing a request to [Get Subcollection by Collection ID](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-subcollection-collectionid).
  • skuId (path, required) — SKU’s unique numerical identifier.
POST

/api/catalog/pvt/supplier

Create Supplier

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
DELETE

/api/catalog/pvt/supplier/{supplierId}

Delete Supplier

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • supplierId (path, required) — Supplier's unique numerical identifier.
PUT

/api/catalog/pvt/supplier/{supplierId}

Update Supplier

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • supplierId (path, required) — Supplier's unique numerical identifier.
GET

/api/catalog_system/pub/category/tree/{categoryLevels}

Get Category Tree

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • categoryLevels (path, required) — Value of the category level you need to retrieve.
GET

/api/catalog_system/pub/products/variations/{productId}

Get Product's SKUs by Product ID

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • productId (path, required) — Product’s unique numerical identifier.
GET

/api/catalog_system/pub/saleschannel/{salesChannelId}

Get Sales Channel by ID

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • salesChannelId (path, required)
POST

/api/catalog_system/pub/sku/stockkeepingunitidsbyrefids

Retrieve SKU ID list by Reference ID list

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
GET

/api/catalog_system/pub/specification/field/listByCategoryId/{categoryId}

Get Specifications By Category ID

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • categoryId (path, required) — Category ID.
GET

/api/catalog_system/pub/specification/field/listTreeByCategoryId/{categoryId}

Get Specifications Tree By Category ID

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • categoryId (path, required) — Category ID.
GET

/api/catalog_system/pub/specification/fieldGet/{fieldId}

Get Specification Field

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • fieldId (path, required) — Specification Field ID.
GET

/api/catalog_system/pvt/sku/stockkeepingunitidbyrefid/{refId}

Get SKU ID by Reference ID

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • refId (path, required) — SKU Reference ID.
GET

/api/catalog_system/pub/specification/fieldvalue/{fieldId}

Get Specification Values By Field ID

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • fieldId (path, required) — Specification Field ID.
GET

/api/catalog_system/pub/specification/groupGet/{groupId}

Get Specification Group

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • groupId (path, required) — Specification Group ID.
GET

/api/catalog_system/pvt/brand/list

Get Brand List

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
GET

/api/catalog_system/pvt/brand/pagedlist

Get Brand List Per Page

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • pageSize (query, required, limit) — Quantity of brands per page.
  • page (query, required, page) — Page number of the brand list.
GET

/api/catalog_system/pvt/brand/{brandId}

Get Brand

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • brandId (path, required) — Brand ID.
GET

/api/catalog_system/pvt/collection/search

Get All Collections

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • page (query, required, page) — Page number.
  • pageSize (query, required, limit) — Number of the items of the page.
  • orderByAsc (query, required) — Defines if the items of the page are in ascending order.
GET

/api/catalog_system/pvt/collection/search/{searchTerms}

Get Collections by search terms

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • searchTerms (path, required) — String that will search for a collection related to it.
  • page (query, page) — Page number.
  • pageSize (query, limit) — Number of the items of the page.
  • orderByAsc (query) — Defines if the items of the page are in ascending order.
GET

/api/catalog_system/pvt/commercialcondition/list

Get all commercial conditions

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
PUT

/api/catalog_system/pvt/specification/fieldValue

Update Specification Field Value

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
GET

/api/catalog_system/pvt/commercialcondition/{commercialConditionId}

Get commercial condition

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • commercialConditionId (path, required) — Commercial condition unique numerical identifier.
GET

/api/catalog_system/pvt/products/GetIndexedInfo/{productId}

Get Product Indexed Information

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • productId (path, required) — Product’s unique numerical identifier.
GET

/api/catalog_system/pvt/products/GetProductAndSkuIds

Get Product and SKU IDs

  • categoryId (query) — ID of the category from which you need to retrieve Products and SKUs.
  • _from (query) — Insert the ID that will start the request result.
  • _to (query) — Insert the ID that will end the request result.
  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
GET

/api/catalog_system/pvt/products/productget/{productId}

Get Product and its general context

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • productId (path, required) — Product’s unique numerical identifier.
GET

/api/catalog_system/pvt/products/productgetbyrefid/{refId}

Get Product by RefId

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • refId (path, required) — Product Referecial Code
GET

/api/catalog_system/pvt/products/{productId}/specification

Get Product Specification by Product ID

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • productId (path, required) — Product’s unique numerical identifier.
POST

/api/catalog_system/pvt/products/{productId}/specification

Update Product Specification by Product ID

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • productId (path, required) — Product’s unique identifier.
GET

/api/catalog_system/pvt/saleschannel/list

Get Sales Channel List

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
POST

/api/catalog_system/pvt/seller

Create Seller

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
PUT

/api/catalog_system/pvt/seller

Update Seller

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
GET

/api/catalog_system/pvt/seller/list

Get Seller List

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • sc (query) — Trade policy ID.
  • sellerType (query) — Seller type.
  • isBetterScope (query) — If the seller is better scope.
GET

/api/catalog_system/pvt/seller/{sellerId}

Get Seller by ID

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • sellerId (path, required) — ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the correct ID.
GET

/api/catalog_system/pvt/sku/stockkeepingunitids

List all SKU IDs

  • page (query, required, page) — Number of the page from where you need to retrieve SKU IDs.
  • pagesize (query, required, limit) — Size of the page from where you need retrieve SKU IDs. The maximum value is `1000`.
  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
GET

/api/catalog_system/pvt/sellers/{sellerId}

Get Seller by ID

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • sellerId (path, required) — ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the correct ID.
POST

/api/catalog_system/pvt/sku/associateattachments

Associate attachments to an SKU

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
GET

/api/catalog_system/pvt/sku/complements/{parentSkuId}/{type}

Get SKU complements by type

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • parentSkuId (path, required) — ID of the Parent SKU, where the Complement is inserted.
  • type (path, required) — Complement Type ID. This represents the type of the complement. The possible values are: `1` for Accessory; `2` for Suggestion; `3` for Similar Product; `5` for Show Together.
GET

/api/catalog_system/pvt/sku/stockkeepingunitByProductId/{productId}

Get SKU list by Product ID

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • productId (path, required) — Product’s unique numerical identifier.
GET

/api/catalog_system/pvt/sku/stockkeepingunitbyalternateId/{alternateId}

Get SKU by Alternate ID

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • alternateId (path, required) — Product EAN or RefId.
GET

/api/catalog_system/pvt/sku/stockkeepingunitbyean/{ean}

Get SKU by EAN

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • ean (path, required) — EAN of the SKU which you need to retrieve details from.
GET

/api/catalog_system/pvt/sku/stockkeepingunitbyid/{skuId}

Get SKU and context

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (path, required) — SKU's unique identifier number.
  • sc (query) — Trade Policy's unique identifier number.
GET

/api/catalog_system/pvt/sku/stockkeepingunitidsbysaleschannel

List all SKUs of a Trade Policy

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • sc (query, required) — Trade Policy’s unique numerical identifier.
  • page (query, page) — Page number.
  • pageSize (query, limit) — Number of items in the page.
  • onlyAssigned (query) — If set as `false`, it allows the user to decide if the SKUs that are not assigned to a specific trade policy should be also returned.
POST

/api/catalog_system/pvt/skuseller/changenotification/{sellerId}/{sellerSkuId}

Change Notification with Seller ID and Seller SKU ID

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • sellerId (path, required) — ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the correct ID.
  • sellerSkuId (path, required) — ID of the binding of the seller with the SKU.
POST

/api/catalog_system/pvt/skuseller/changenotification/{skuId}

Change Notification with SKU ID

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • skuId (path, required) — A string that identifies the SKU in the marketplace. This is the ID that the marketplace will use to look for the SKU whose change the seller wants to inform. If the marketplace finds this ID, it responds with status code 200. Otherwise, it responds with status code 404.
POST

/api/catalog_system/pvt/skuseller/remove/{sellerId}/{sellerSkuId}

Remove a seller's SKU binding

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • sellerId (path, required) — ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the correct ID.
  • sellerSkuId (path, required) — SKU ID in the seller's store.
GET

/api/catalog_system/pvt/skuseller/{sellerId}/{sellerSkuId}

Get details of a seller's SKU

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • sellerId (path, required) — ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the correct ID.
  • sellerSkuId (path, required) — SKU ID in the seller's store.
POST

/api/catalog_system/pvt/specification/field

Create Specification Field

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
PUT

/api/catalog_system/pvt/specification/field

Update Specification Field

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
POST

/api/catalog_system/pvt/specification/fieldValue

Create Specification Field Value

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
GET

/api/catalog_system/pvt/specification/fieldValue/{fieldValueId}

Get Specification Field Value

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • fieldValueId (path, required)
GET

/api/catalog_system/pvt/specification/groupbycategory/{categoryId}

List Specification Group by Category

  • Content-Type (header, required) — Describes the type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • categoryId (path, required)

162 endpoints auto-detected

Authentication

This API uses an API key, passed in the "X-VTEX-API-AppKey" header. No OAuth required.

curl -X POST \
  "https://vtex.local/api/catalog/pvt/collection" \
  -H "X-VTEX-API-AppKey: YOUR_API_KEY"

vtex.local · HTTPS only