Catalog API

The Catalog API empowers merchants to seamlessly manage their product information. It enables the creation, modification, and deletion of product details, including attributes like images and specifications. SKU management covers product variations. This API also supports organizing products into categories, collections, and manage brands.

The default rate limit for the Catalog API is 45,000 requests per minute per account, and 15,000 requests per minute per endpoint.

The SKU ID is an integer with a maximum value of 2,147,483,647.

Check the Catalog onboarding guide, created 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.

Index

Category

• GET Get category tree
• GET Get category by ID
• PUT Update category
• POST Create category

Category specification

• GET Get specifications by category ID
• GET Get specifications tree by category ID

Brand

• 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

Specification group

• GET List specification group by category
• GET Get specification group
• POST Create specification group
• PUT Update specification group

Specification

• GET Get specification
• PUT Update specification
• POST Create specification

Specification field

• GET Get specification field
• POST Create specification field
• PUT Update specification field

Non-structured specification

• GET Get non-structured specification by ID
• DELETE Delete non-structured specification
• GET Get non-structured specification by SKU ID
• DELETE Delete non-structured specification by SKU ID

Specification value

• GET Get specification value
• PUT Update specification value
• POST Create specification value

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

Product

• 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 reference ID
• GET Get product's SKUs by product ID
• GET Get product review rate by product ID
• POST Create product with category and brand

Product specification

• GET Get product specifications 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 product specification
• PUT Associate product specification using specification name and group name

SKU

• GET List all SKU IDs
• GET SKU and context
• GET Get SKU by reference ID
• 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

SKU specification

• 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

SKU file

• GET Get SKU files
• POST Create SKU file
• DELETE Delete All SKU files
• PUT Update SKU file
• PUT Reorder SKU files
• DELETE Delete SKU image file
• PUT Copy files from a SKU to another SKU
• DELETE Disassociate SKU file

SKU complement

• 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

SKU EAN

• 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

Attachment

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

SKU attachment

• 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

SKU service

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

SKU service attachment

• 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

• POST Create SKU service type
• GET Get SKU service type
• PUT Update SKU service type
• DELETE Delete SKU service type

SKU service value

• POST Create SKU service value
• GET Get SKU service value
• PUT Update SKU service value
• DELETE Delete SKU service value

SKU kit

• 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 kit ID

SKU seller

• 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

SKU attribute

• POST Create SKU attribute
• UPDATEUpdate SKU attribute
• GET Get SKU attribute by ID
• GET Get all SKU attributes
• DELETE Delete SKU attribute
• DELETE Delete all SKU attributes

Multi-language

• GET Get product translation by product ID
• PUT Create or update product translation by product ID
• GET Get product specification translation by product ID
• PUT Create or update product specification translation by product ID

Multi-language SKU

• GET Get SKU translation by SKU ID
• PUT Create or update SKU translation by SKU ID
• GET Get SKU attribute translation by SKU ID
• PUT Create or update SKU attribute translation by SKU ID
• GET Get SKU file translation by SKU ID
• PUT Create or update SKU file translation by SKU ID

Multi-language specification

• GET Get specification group translation
• PUT Create or update specification group translation
• GET Get specification translation
• PUT Create or update specification translation
• GET Get specification value translation
• PUT Create or update specification value translation

Multi-language category

• GET Get category translation
• PUT Create or update category translation

Multi-language brand

• GET Get brand translation
• PUT Create or update brand translation

Multi-language attachment and service

• GET Get attachment translation
• PUT Create or update attachment translation
• GET Get SKU service type translation
• PUT Create or update SKU service type translation
• GET Get SKU service translation
• PUT Create or update SKU service translation
• GET Get SKU service value translation
• PUT Create or update SKU service value translation

Multi-language collection

• GET Get collection translation
• PUT Create or update collection translation

Similar category

• GET Get similar categories
• POST Add similar category
• DELETE Delete similar category

Collection

• GET Get all inactive collections
• POST Create collection
• 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
• GET Get collection by ID
• PUT Update collection
• DELETE Delete collection

Subcollection

• 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 by subcollection ID
• PUT Update subcollection
• DELETE Delete subcollection
• POST Create subcollection
• POST Reposition SKU on the subcollection
• GET Get specification values by subcollection ID
• POST Use specification value in subcollection by ID
• DELETE Delete specification value from subcollection by ID

Seller

• GET Get seller list
• GET Get seller by ID
• PUT Update seller
• POST Create seller
• GET Get seller by ID

Supplier

• POST Create supplier
• PUT Update supplier
• DELETE Delete supplier

Sales channel

• GET Get sales channel by ID
• GET Get sales channel by product ID
• GET Get sales channel list
• POST Associate product with sales channel
• DELETE Remove product from sales channel
• GET List all SKUs in a sales channel

Product indexing

• GET Get product indexed information

Commercial conditions

• GET Get all commercial conditions
• GET Get commercial condition

Gift list

• GET Get gift list

Common parameters

Parameter name	Description	Type
{{accountName}}	Name of the VTEX account. Used as part of the URL.	Server variable.
{{environment}}	Environment to use. Used as part of the URL. The default value is vtexcommercestable.	Server variable.
X-VTEX-API-AppKey	Unique identifier of the API key.	Authentication header. Must be used together with X-VTEX-API-AppToken. Not necessary when using VtexIdclientAutCookie.
X-VTEX-API-AppToken	Secret token of the API key.	Authentication header. Must be used together with X-VTEX-API-AppKey. Not necessary when using VtexIdclientAutCookie.
VtexIdclientAutCookie	User token, valid for 24 hours.	Authentication header. Not necessary when using X-VTEX-API-AppKey and X-VTEX-API-AppToken.