Catalog API - Overview

📘

Onboarding guide

Check the new Catalog onboarding guide. 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. All content that comes between {{}} keys must be replaced with the correct data before performing the request.

Index

  • Product - Here you can consult, create, or update a Product. For more information, check this article.
  • Product Specification - You can consult, create, or update additional information of a Product. For more information, check this article.
  • SKU - Here you can consult, create, or update an SKU. For more information, check this article.
  • SKU Complement - You can consult, create, or update an SKU Complement. An SKU Complement is a new SKU that has a Parent SKU.
  • SKU EAN - Here you can consult, create, or update an SKU unique identification code (barcode).
  • SKU Attachment - You can consult, create, or update an SKU Attachment. An attachment is used to add custom information about the item. For more information, check this article.
  • SKU File - Here you can consult, create, or update an SKU File. An SKU File is an image associated with an SKU.
  • SKU Kit - You can consult, create, or update an SKU Kit. A kit is an SKU composed of one or more SKUs. For more information, check this article.
  • SKU Seller - Here you can consult and delete an SKU Seller. An SKU Seller is a seller associated with an SKU. For more information, check this article.
  • SKU Service - You can 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.
  • SKU Service Attachment - Here you can associate or disassociate an Attachment to an SKU Service.
  • SKU Service Type - You can create, update, or delete an SKU Service Type. A service type is the behavior configuration of a service.
  • SKU Service Value - Here you can create, update, or delete an SKU Service Value. Service value is how much the customer will be charged for the service.
  • SKU Specification - You can consult, 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.
  • SKU Subcollection - Here you can can consult, create, or delete an SKU Subcollection. A subcollection is a group type associated with a collection. For more information, check this article.
  • Category - You consult, create, or update a Category. A category is a hierarchical level of product classification. For more information, check this article.
  • Similar Category - Here you can create and delete a Similar Category to a Product. This way the Product will be shown in both categories (main and similar).
  • Category Specification - You can consult all Specifications by Category. For more information about Specification, check this article.
  • Category Subcollection - Here you can associate or disassociate a subcollection to a category.
  • Brand - You can consult, create, update, or delete a Brand. A brand is a product property. For more information, check this article.
  • Brand Subcollection - Here you can associate or disassociate a subcollection to a brand.
  • Attachment - You can consult, create, or update an Attachment. An attachment is used to add custom information about the item. For more information, check this article.
  • Collection Beta - The new Beta Collections module launch allowed us to engineer new endpoints that create and manage Collections. For more information, check this article.
  • Collection - Here you can consult, create, update, or delete a Collection. A collection is a group of items. For more information, check this article.
  • Collection CMS - Here you can create a Collection CMS. A collection is a group of items. For more information, check this article.
  • Subcollection - You can can consult, create, update, or delete a Subcollection. A subcollection is a group type associated with a collection. For more information, check this article.
  • Specification - Here you can consult, 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.
  • Specification Field - You can consult, create, or update a Specification Field. A specification field allows you to present more detailed items.
  • Specification Field Value - Here you can consult, create, or update a Specification Field Value.
  • Specification Value - You can consult, create, or update a Specification Value.
  • Specification Group - Here you can consult, create, or update a Specification Group.
  • Non Structured Specification - You can consult or delete a Non Structured Specification.
  • Sales Channel - Here you can consult Sales Channel.
  • Seller - You can consult, create, or update a Seller. A seller is the product owner. For more information, check this article.
  • Supplier - Here you can consult, create, or update a Supplier.
  • Trade Policy - You can create, update, or delete a Trade Policy. Trade policy is required when one of the above factors is different among the sale channel. For more information, check this article.
  • Product Indexed - Here you can consult Product Indexed information.

Common parameters

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