API Reference

Getting started

Help us improve our documentation! Tell us about your experience with this article by filling out this form.

Catalog is your store's administration module for configuring the features related to your ecommerce products to make them available for customers on your website. This overview article goes over what you can accomplish with the VTEX Catalog, including relevant links to our developer documentation about this topic.

Understanding Catalog architecture

On VTEX, Categories are the way products are organized, generically dividing items available in your store. Usually, they have three levels: department, category, and subcategory.

Each product is associated with a category and a brand, and has at least one Stock Keeping Unit (SKU), which corresponds to each product variation – each physical unit in stock.

Categories are associated with specification groups, which group the product and SKU specifications that will be applied to all items associated with the category. All specifications must be completed for items to be active in your store.

{"base64":"  ","img":{"width":2345,"height":1405,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":180810,"url":""}}

Setting up your catalog

One of the first steps for new stores is to upload products to VTEX, whether from your ERP, back-office system, or other sources. See the links below for an overview of the integration flow and detailed guides about each step of the process.

Integration flow

These links provide a general overview of the steps in the integration flow between a back office system and a VTEX store catalog.

  1. Back office (ERP/PIM/WMS)
  2. Setting up the catalog
  3. Importing products
  4. Updating / deleting information
  5. Catalog
  6. Catalog API - Overview

Looking for storefront Catalog content? Read our Customizing your storefront guides.

Configuring initial settings (MANDATORY)

Access the following links to see details about each step and API call while uploading products to your VTEX Catalog. All these steps are required and must be completed in the order below, regardless of whether you are connecting to VTEX through an external system.

1. Categories

Categories arrange your product assortment in hierarchical levels of product classification. The category system makes a customer search for a product easier and keeps your catalog organized. The three main category levels are called department, category, and subcategory.

2. Brands

A brand is an attribute that helps your end customers identify a product and the company behind it.

3. Specifications

Specifications are additional properties that can be added to your store products or SKUs. On VTEX, you must first create a specification group linked to a category and then include the desired specification fields that will be replicated in all products or SKUs in the category.

When a group is created in a department or a category, it will be replicated in all the sublevels of that department or category, following an "inheritance" logic. Therefore, to create a specification group applicable to one category only, you must create it at that category level.

4. Products

A product is a generic definition of an item available in your store, such as a shirt.

5. SKUs

A SKU, short for "stock keeping unit", represents a physical unit or variation of a product, such as a medium blue shirt. SKUs are the items that stores keep in stock and that end customers actually buy.

Enriching your catalog (MANDATORY)

After the initial product upload, you must enrich them with the required information before selling them. The steps below are required for any product to be available in your store. See the following points for more details.

6. Completing specifications

You need to complete the specifications of each product and SKU based on the fields and values you have created.

7. Adding images to SKUs

Every SKU needs at least one image to be active in your store.

8. Activating SKUs

Read the following guide to understand how to activate SKUs and make them available in your store.

Adding optional settings

Once you have all the required information, there are optional settings you can configure to enhance your catalog. See the following links for more information.


An attachment is an optional and free product customization. It is used to add information to a SKU.

Assembly options

An assembly option is an attachment for complex cases, such as product customization, where you need to manage different product combinations, quantity, additional items, costs, and product inventory and display these options on the product page.


A service is an extra that may come with a product, optionally and at a cost. It is used to assign an additional service to a SKU, such as gift packaging, customization, or special warranty deals.


A kit is a set of SKUs that are sold together, a SKU composed of one or more SKUs.


A collection is a group of two or more SKUs that may or may not have common features to be displayed on your store product pages. You can create collections using grouping criteria such as special dates, launches, or best-selling products. You can create collections using either Legacy CMS Portal or Collections beta.

Legacy CMS Portal

Collections Beta

Trade policies (sales channels)

When operating with multiple trade policies, you can define which products will be available on each trade policy.

Customizing your storefront

To understand how to build your storefront and display your product assortment, read the articles in this section. The rest of this guide focuses on Admin related settings and actions.


Learn how to build Catalog related pages in your storefront using VTEX IO.

Find more information in our Storefront implementation guides.

Integrating with external marketplaces or sellers

Learn more about integrating with non-VTEX marketplaces or sellers through the following documentation.

External Marketplace

If you are an external marketplace that wishes to integrate with VTEX sellers, you can see the links below to learn how to develop a custom connector to connect with VTEX's architecture and sellers' catalogs.

External Seller

See the documentation below to understand how to integrate an external seller’s offers into your catalog if you act as a VTEX marketplace.

Photo of the contributor
Photo of the contributor
Photo of the contributor
Photo of the contributor
Photo of the contributor
+ 5 contributors
Was this helpful?
Suggest edits (Github)
Photo of the contributor
Photo of the contributor
Photo of the contributor
Photo of the contributor
Photo of the contributor
+ 5 contributors
On this page