The Catalog API provides methods for managing and retrieving products, SKUs, categories, brands, and other catalog information.

Check out the new Catalog onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX. It combines all our Developer Portal documentation about Catalog and focuses on the developer's journey.

Parameter name	Description
{{accountName}}	Store account name
{{environment}}	The environment that will be called. Change to vtexcommercestable or vtexcommmercebeta.
{{X-VTEX-API-AppKey}}	Located in the request headers, user authentication key.
{{X-VTEX-API-AppToken}}	Located in the request headers, authentication password.

All content between {{}} keys must be replaced with the correct data before performing the request.

Retrieve, create, or update a Category. A category is a hierarchical level of product classification. For more information, check this article.

• GET Get Category Tree
• GET Get Category by ID
• PUT Update Category
• POST Create Category

Retrieve all Specifications by Category. For more information about Specification, check this article.

• GET Get Specifications By Category ID
• GET Get Specifications Tree By Category ID

Retrieve, create, update, or delete a Brand. For more information, check this article.

• GET Get Brand List
• GET Get Brand List Per Page
• GET Get Brand
• POST Create Brand
• GET Get Brand and context
• PUT Update Brand
• DELETE Delete Brand

Retrieve, create, or update a Specification Group.

• GET List Specification Group by Category
• GET Get Specification Group
• POST Create Specification Group
• PUT Update Specification Group

Retrieve, create, or delete a Specification. A specification is used to create site browsing filters and to differentiate SKUs and Products within the product page. For more information, check this article.

• GET Get Specification
• PUT Update Specification
• POST Create Specification

Specification Field

Retrieve, create, or update a Specification Field. A specification field allows you to present more detailed items.

• GET Get Specification Field
• POST Create Specification Field
• PUT Update Specification Field

Non Structured Specification

Retrieve or delete a Non Structured Specification.

• GET Get Non Structured Specification by ID
• DELETE Delete Non Structured Specification

Retrieve, create, or update a Specification Value.

• GET Get Specification Value
• PUT Update Specification Value
• POST Create Specification Value

Specification Field Value

Retrieve, create, or update a Specification Field Value.

• GET Get Specification Field Value
• GET Get Specification Values By Field ID
• POST Create Specification Field Value
• PUT Update Specification Field Value

Retrieve, create, or update a product. For more information, check this article.

• GET Get Product and SKU IDs
• GET Get Product by ID
• PUT Update Product
• GET Get Product and its general context
• GET Get Product by RefId
• GET Get Product's SKUs by Product ID
• GET Get Product Review Rate by Product ID
• POST Create Product with Category and Brand

Retrieve, create, or update additional information of a product. For more information, check this article.

• GET Get Product Specification by Product ID
• POST Update Product Specification by Product ID
• GET Get Product Specification and its information by Product ID
• POST Associate Product Specification
• DELETE Delete all Product Specifications by Product ID
• DELETE Delete a specific Product Specification
• PUT Associate product specification using specification name and group name

Retrieve, create, or update an SKU. For more information, check this article.

• GET List all SKU IDs
• GET Get SKU and context
• GET Get SKU by RefId
• POST Create SKU
• GET Get SKU ID by Reference ID
• GET Get SKU by Alternate ID
• GET Get SKU list by Product ID
• POST Retrieve SKU ID list by Reference ID list
• GET Get SKU
• PUT Update SKU

Retrieve, create, or delete an SKU Specification. SKU Specification is used to create site browsing filters and to differentiate SKUs within the product page. For more information, check this article.

• GET Get SKU Specifications
• POST Associate SKU Specification
• PUT Update SKU Specification
• DELETE Delete all SKU Specifications
• DELETE Delete SKU Specification
• PUT Associate SKU specification using specification name and group name

Retrieve, create, or update an SKU file. An SKU file is an image linked to a SKU.

• GET Get SKU Files
• POST Create SKU File
• DELETE Delete All SKU Files
• PUT Update SKU File
• DELETE Delete SKU Image File
• PUT Copy Files from an SKU to another SKU
• DELETE Disassociate SKU File

Retrieve, create, or update an SKU Complement. An SKU Complement is an SKU that has a Parent SKU.

• GET Get SKU Complement by SKU ID
• GET Get SKU Complements by Complement Type ID
• GET Get SKU complements by type
• POST Create SKU Complement
• GET Get SKU Complement by SKU Complement ID
• DELETE Delete SKU Complement by SKU Complement ID

Retrieve, create, or update an SKU unique identification code (barcode).

• GET Get SKU by EAN
• GET Get EAN by SKU ID
• DELETE Delete all SKU EAN values
• POST Create SKU EAN
• DELETE Delete SKU EAN

Retrieve, create, or update an Attachment. An attachment is used to add custom information about an item. For more information, check this article.

• GET Get attachment
• PUT Update attachment
• DELETE Delete attachment
• POST Create attachment
• GET Get all attachments

Retrieve, create, or update an SKU Attachment. An attachment is used to add custom information about the item. For more information, check this article.

• POST Associate SKU Attachment
• DELETE Dissociate attachments and SKUs
• GET Get SKU Attachments by SKU ID
• DELETE Delete SKU Attachment by Attachment Association ID
• POST Associate attachments to an SKU

Create, update, or delete an SKU Service. A service is an item that may come with a product, optionally, and with a cost. For more information, check this article.

• GET Get SKU Service
• PUT Update SKU Service
• DELETE Dissociate SKU Service
• POST Associate SKU Service

SKU Service Attachment

Associate or disassociate an Attachment to an SKU Service.

• POST Associate SKU Service Attachment
• DELETE Dissociate Attachment by Attachment ID or SKU Service Type ID
• DELETE Dissociate Attachment from SKU Service Type

SKU Service Type

Create, update, or delete an SKU Service Type. A service type is the behavior configuration of a service.

• POST Create SKU Service Type
• GET Get SKU Service Type
• PUT Update SKU Service Type
• DELETE Delete SKU Service Type

SKU Service Value

Create, update, or delete an SKU Service Value. Service value is how much the customer will be charged for the service.

• POST Create SKU Service Value
• GET Get SKU Service Value
• PUT Update SKU Service Value
• DELETE Delete SKU Service Value

Retrieve, create, or update an SKU Kit. A kit is an SKU composed of one or more SKUs. For more information, check this article.

• GET Get SKU Kit by SKU ID or Parent SKU ID
• POST Create SKU Kit
• DELETE Delete SKU Kit by SKU ID or Parent SKU ID
• GET Get SKU Kit
• DELETE Delete SKU Kit by KitId

Retrieve and delete an SKU Seller. An SKU Seller is a seller associated with an SKU. For more information, check this article.

• GET Get details of a seller's SKU
• POST Remove a seller's SKU binding
• POST Change Notification with Seller ID and Seller SKU ID
• POST Change Notification with SKU ID

Retrieve, create or delete a similar category related to a product. By creating a similar category, the product will be shown in both categories (main and similar).

• GET Get Similar Categories
• POST Add Similar Category
• DELETE Delete Similar Category

The Beta Collections module provides endpoints to create and manage Collections. For more information, check this article.

• GET Get All Collections
• GET Get All Inactive Collections
• POST Create Collection
• GET Get Collections by search terms
• GET Import Collection file example
• POST Add products to Collection by imported file
• POST Remove products from Collection by imported file
• GET Get products from a collection

Retrieve, create, update, or delete a collection. A collection is a group of items. For more information, check this article.

• GET Get Collection
• PUT Update Collection
• DELETE Delete Collection
• POST Create Collection

Retrieve, create, or delete an SKU, Brand or Category from a Subcollection, as well as create, delete and update subcollections. A subcollection is a group type associated with a collection. For more information, check this article.

• POST Add SKU to Subcollection
• DELETE Delete SKU from Subcollection
• POST Associate Category to Subcollection
• DELETE Delete Category from Subcollection
• POST Associate Brand to Subcollection
• DELETE Delete Brand from Subcollection
• GET Get Subcollection by Collection ID
• GET Get Subcollection
• PUT Update Subcollection
• DELETE Delete Subcollection
• POST Create Subcollection
• POST Reposition SKU on the Subcollection

Retrieve, create, or update a Seller. For more information, check this article.

• GET Get Seller List
• GET Get Seller by ID
• PUT Update Seller
• POST Create Seller
• GET Get Seller by ID

Retrieve, create, or update a Supplier.

• POST Create Supplier
• PUT Update Supplier
• DELETE Delete Supplier

Create, update, or delete a trade policy.

• GET Get Trade Policies by Product ID
• POST Associate Product with Trade Policy
• DELETE Remove Product from Trade Policy
• GET List all SKUs of a Trade Policy

Sales Channel

Retrieve trade policies (also known as sales channels).

• GET Get Sales Channel List
• GET Get Sales Channel by ID

Retrieve Product Indexed information.

• GET Get Product Indexed Information

Retrieve commercial conditions registered in the store.

• GET Get all commercial conditions
• GET Get commercial condition

Retrieve information about gift lists registered in your store.

• GET Get Gift List