[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides catalog overview in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/getting-started)

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview)

[Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/marketplace-overview)

[Orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/orders-overview)

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/checkout-overview)

[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/payments-overview)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/fulfillment)

[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/search-overview)

[Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/pricing-overview)

[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/promotions-overview)

[Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/subscriptions)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/getting-started)

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview)

[Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/marketplace-overview)

[Orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/orders-overview)

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/checkout-overview)

[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/payments-overview)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/fulfillment)

[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/search-overview)

[Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/pricing-overview)

[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/promotions-overview)

[Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/subscriptions)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides)

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/getting-started)

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview)

Catalog

> **Help us improve our documentation!** Tell us about your experience with this article by filling out [this form](https://read.calvincode.net/reader?url=https://forms.gle/fQoELRA1yfKDqmAb8).

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](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/2gkZDjXRqfsq62TlAkj4uf) are the way products are organized, generically dividing items available in your store. Usually, they have three levels: department, category, and subcategory.

Each [product](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/1wmX3QvQVxbKVmalhIE5Ru) is associated with a category and a [brand](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/7i3sB8fgkqUp5NoH5yJtfh), and has at least one [Stock Keeping Unit (SKU)](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/3mJbIqMlz6oKDmyZ2bKJoA), which corresponds to each product variation – each physical unit in stock.

Categories are associated with [specification](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/2NQoBv8m4Yz3oQaLgDRagP) 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":"https://raw.githubusercontent.com/vtexdocs/dev-portal-content/d54af4780304904cfb383ed60497ac3f200db383/docs/guides/Getting%20Started/catalog-architecture.png"}}](https://read.calvincode.net/reader?url=https://raw.githubusercontent.com/vtexdocs/dev-portal-content/d54af4780304904cfb383ed60497ac3f200db383/docs/guides/Getting%20Started/catalog-architecture.png)

## 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)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide)
2. [Setting up the catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog)
3. [Importing products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products)
4. [Updating / deleting information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information)
5. [Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration)
6. [Catalog API - Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23overview)

> Looking for storefront Catalog content? Read our [Customizing your storefront](#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.

* [Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories)
* [Catalog API - Category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pub/category/tree/-categoryLevels-)

#### 2\. Brands

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

* [Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands)
* [Catalog API - Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/brand/list)

#### 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.

* [Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications)
* [Catalog API - Specification group](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/specification/groupbycategory/-categoryId-)
* [Catalog API - Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/specification/-specificationId-)
* [Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications)
* [Catalog API - Product specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/products/-productId-/specification)
* [SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications)
* [Catalog API - SKU specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunit/-skuId-/specification)

#### 4\. Products

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

* [Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/products)
* [Catalog API - Product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/products/GetProductAndSkuIds)
* [Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests)
* [Implementing product color variation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-implement-product-color-variation)

#### 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.

* [SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus)
* [Catalog API - SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/sku/stockkeepingunitids)

### 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.

* [Updating SKU specifications with the Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api)
* [Catalog API - Specification value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/specificationvalue/-specificationValueId-)

#### 7\. Adding images to SKUs

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

* [Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images)
* [Catalog API - SKU file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunit/-skuId-/file)

#### 8\. Activating SKUs

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

* [How to activate a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus%23activating-an-sku)

### 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.

#### Attachments

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

* [Catalog API - Attachment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/attachment/-attachmentid-)
* [Catalog API - SKU attachment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/skuattachment)

#### 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.

* [Assembly options](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH)
* [Assembly Options app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/assembly-options-app)

#### Services

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.

* [Catalog API - SKU service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/skuservice/-skuServiceId-)
* [Catalog API - SKU service attachment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/skuservicetypeattachment)
* [Catalog API - SKU service type](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/skuservicetype)
* [Catalog API - SKU service value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/skuservicevalue)

#### Kits

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

* [Catalog API - SKU kit](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-sku-kit)

#### Collections

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**

* [Catalog API - Collection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/collection/-collectionId-)
* [Catalog API - Subcollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/collection/-collectionId-/subcollection)
* [Catalog API - Category subcollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/subcollection/-subCollectionId-/category)
* [Catalog API - Brand subcollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/subcollection/-subCollectionId-/brand)
* [Catalog API - SKU subcollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/subcollection/-subCollectionId-/stockkeepingunit)

**Collections Beta**

* [Catalog API - Collections beta](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/%23get-/api/catalog%5Fsystem/pvt/collection/search)

#### Trade policies (sales channels)

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

* [How trade policies work](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)
* [Catalog API - Trade policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/product/-productId-/salespolicy)

## 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.

### VTEX IO

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

* [Building a horizontal product summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary)
* [Building a product details page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page)
* [Building a shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-shelf)
* [Configuring custom images for the SKU selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector)
* [Creating a product availability form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form)
* [Rendering a badge on top of a product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge)
* [Translating Catalog content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-internationalization)

Find more information in our [Storefront implementation guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation).

## 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 Marketplace Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide)
* [Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-catalog)
* [Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs)
* [Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load)
* [How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-new-products)
* [How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates)
* [Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-catalog-mapping)

### 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.

* [External Seller Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide)
* [Catalog management for VTEX Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation)

Contributors

5

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F106821144%3Fv%3D4%26w=64%26q=75)](https://github.com/GeorgeLimaDev)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F83723439%3Fv%3D4%26w=64%26q=75)](https://github.com/jumeyermattosarruda)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7108339%3Fv%3D4%26w=64%26q=75)](https://github.com/brunoamui)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Getting-Started/catalog-overview.md)

[Getting started« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview//docs/guides/getting-started)[MarketplaceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview//docs/guides/marketplace-overview)

Contributors

5

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F106821144%3Fv%3D4%26w=64%26q=75)](https://github.com/GeorgeLimaDev)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F83723439%3Fv%3D4%26w=64%26q=75)](https://github.com/jumeyermattosarruda)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7108339%3Fv%3D4%26w=64%26q=75)](https://github.com/brunoamui)

ON THIS PAGE

[Understanding Catalog architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23understanding-catalog-architecture)

[Setting up your catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23setting-up-your-catalog)

[Integration flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23integration-flow)[Configuring initial settings (MANDATORY)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23configuring-initial-settings-mandatory)[Enriching your catalog (MANDATORY)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23enriching-your-catalog-mandatory)[Adding optional settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23adding-optional-settings)

[Customizing your storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23customizing-your-storefront)

[VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23vtex-io)

[Integrating with external marketplaces or sellers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23integrating-with-external-marketplaces-or-sellers)

[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23external-marketplace)[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23external-seller)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Getting-Started/catalog-overview.md)

Copy page

On this page

ON THIS PAGE

[Understanding Catalog architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23understanding-catalog-architecture)

[Setting up your catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23setting-up-your-catalog)

[Integration flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23integration-flow)[Configuring initial settings (MANDATORY)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23configuring-initial-settings-mandatory)[Enriching your catalog (MANDATORY)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23enriching-your-catalog-mandatory)[Adding optional settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23adding-optional-settings)

[Customizing your storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23customizing-your-storefront)

[VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23vtex-io)

[Integrating with external marketplaces or sellers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23integrating-with-external-marketplaces-or-sellers)

[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23external-marketplace)[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23external-seller)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides faststore api extensions best practices in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/getting-started-overview)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/developing-and-overriding-components-overview)

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-overview)

[Extending API schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-extending-api-schema)

[Extending queries using fragments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-extending-queries-using-fragments)

[Consuming FastStore API extension with custom components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-consuming-api-extensions)

[Best practices for using API extensions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-best-practices)

[API extensions - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-use-cases-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/getting-started-overview)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/developing-and-overriding-components-overview)

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-overview)

[Extending API schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-extending-api-schema)

[Extending queries using fragments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-extending-queries-using-fragments)

[Consuming FastStore API extension with custom components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-consuming-api-extensions)

[Best practices for using API extensions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-best-practices)

[API extensions - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-use-cases-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/storefront-best-practices)

---

[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/storefront-development)

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore)

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-overview)

Best practices for using API extensions

The[ @faststore/core](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview%23packagejson) package version 3.x introduces enhancements to API extension with a more efficient GraphQL query handling and security measures enhancements.

In this guide, learn to configure API extensions, ensuring the following:

* Use the `gql` helper usage for smoother and more efficient GraphQL query handling.
* Implement a more secure method for invoking queries and mutations to safeguard your store's data.
* Optimize call processes for queries or mutations defined within `@faststore/core`.

## Before you begin

Make sure your store version is updated to v3.0.0 or above. If it’s not updated, refer to the [Updating your @faststore/core package version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version) section.

## Updating the `gql` helper usage

The `gql` helper serves as a function to define GraphQL operations such as queries, mutations, or fragments within the store code. See the example below:

/fragments/ClientProduct.tsx

`` 1

import { gql } from '@faststore/graphql-utils'

2

3

export const fragment = gql`

4

 fragment ClientProduct on Query {

5

 product(locator: $locator) {

6

 id: productID

7

 breadcrumbList {

8

 itemListElement {

9

 item

10

 name

11

 position

12

 }

13

 }

14

 }

15

}

16

`

 ``

Import the `gql` helper from `@faststore/core/api`and call it as a function - with the argument between parenthesis. This also applies to query and mutation definitions inside the components. For example:

fragments/ClientProduct.tsx

`` 1

import { gql } from '@faststore/core/api'

2

3

export const fragment = gql(`

4

 fragment ClientProduct on Query {

5

 product(locator: $locator) {

6

 id: productID

7

 breadcrumbList {

8

 itemListElement {

9

 item

10

 name

11

 position

12

 }

13

 }

14

 }

15

 }

16

`)

 ``

## Using `useQuery` hook to call queries and mutations

Queries, and mutations are must be invoked using secure hashes, which are randomly generated. To that, pass the query or mutation object - the result of the `gql` call - to `useQuery` directly. For example:

`` 1

import { gql } from '@faststore/core/api'

2

import { useQuery_unstable as useQuery } from '@faststore/core/src/experimental'

3

4

const query = gql(`

5

query MyCustomQuery {

6

 customQuery() {

7

 data

8

 }

9

}

10

`)

11

12

// useQuery appropriately calls MyCustomQuery

13

function CustomComponent() {

14

 // ...

15

 const result = useQuery(query, variables)

16

 // ...

17

}

 ``

## Calling queries or mutations defined by `@faststore/core`

A custom component can call a query or mutation defined by `@faststore/core`, such as `ClientManyProductsQuery`. In these cases, replace the `useQuery` hook call with a call to the specific hook for that query.

`1

import { useClientManyProducts_unstable as useClientManyProducts } from '@faststore/core/src/experimental'

2

3

// ClientManyProductsQuery will be called with the variables passed by CustomComponent

4

function CustomComponent() {

5

 // ...

6

 const result = useClientManyProducts(variables)

7

 // ...

8

}

`

Contributors

3

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F67270558%3Fv%3D4%26w=64%26q=75)](https://github.com/mariana-caetano)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F3356699%3Fv%3D4%26w=64%26q=75)](https://github.com/hellofanny)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/api-extensions/best-practices.mdx)

[Consuming FastStore API extension with custom components« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-consuming-api-extensions)[API extensions - Use casesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-use-cases-overview)

Contributors

3

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F67270558%3Fv%3D4%26w=64%26q=75)](https://github.com/mariana-caetano)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F3356699%3Fv%3D4%26w=64%26q=75)](https://github.com/hellofanny)

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-best-practices%23before-you-begin)

[Updating the gql helper usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-best-practices%23updating-the-gql-helper-usage)

[Using useQuery hook to call queries and mutations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-best-practices%23using-usequery-hook-to-call-queries-and-mutations)

[Calling queries or mutations defined by @faststore/core](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-best-practices%23calling-queries-or-mutations-defined-by-faststorecore)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/api-extensions/best-practices.mdx)

Copy page

On this page

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-best-practices%23before-you-begin)

[Updating the gql helper usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-best-practices%23updating-the-gql-helper-usage)

[Using useQuery hook to call queries and mutations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-best-practices%23using-usequery-hook-to-call-queries-and-mutations)

[Calling queries or mutations defined by @faststore/core](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-best-practices%23calling-queries-or-mutations-defined-by-faststorecore)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides how to activate an sku in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/catalog-integration)

[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/categories)

[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/brands)

[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/products)

[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/specifications)

[Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/product-specifications)

[SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/sku-specifications)

[Updating SKU Specifications with Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/updating-sku-specifications-with-catalog-api)

[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus)

[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/images)

[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/alternative-api-requests)

[How to implement product color variation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/how-to-implement-product-color-variation)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/catalog-integration)

[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/categories)

[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/brands)

[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/products)

[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/specifications)

[Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/product-specifications)

[SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/sku-specifications)

[Updating SKU Specifications with Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/updating-sku-specifications-with-catalog-api)

[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus)

[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/images)

[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/alternative-api-requests)

[How to implement product color variation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/how-to-implement-product-color-variation)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides)

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/catalog-integration)

[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus)

SKUs

A [Stock Keeping Unit (SKU)](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/3mJbIqMlz6oKDmyZ2bKJoA%23) corresponds to the actual item in the inventory that customers can purchase, which means it is equivalent to a product variation at VTEX, such as a _long sleeve gray size S shirt_.

Once you have created a product, it is time to submit its respective SKUs.

> Try the interactive version of this article by accessing this [link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus). Code will be highlighted and focused for your convenience.

## Creating an SKU

To create a new SKU, use the [Create SKU endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit).

Follow these instructions when creating the request body:

* During SKU creation, do not set `IsActive` as `true`. If you send the request to activate the SKU when creating it, you will receive a `400 Bad Request` error. The value to `IsActive` must always be `false` when sending that request for activation to occur afterward, as explained in [Activating an SKU](#activating-an-sku).
* We suggest you set `ActivateIfPossible` as `true,` unless you plan to have an internal workflow to [manually activate SKUs](#manual-activation).
* If there is a need to create a new SKU with a specific custom ID, specify the `Id` (integer) in the request. Otherwise, VTEX will generate the ID automatically.
* Besides the main ID, you must provide at least one of the following alternate IDs in the request body: `RefId` or `EAN`. It is possible to provide both as well.

#### **Request body example (custom ID)**

`1

{

2

 "Id": 1,

3

 "ProductId": 310117069,

4

 "IsActive": false,

5

 "ActivateIfPossible": true,

6

 "Name": "sku test",

7

 "RefId": "125478",

8

 "Ean": "8949461894984",

9

 "PackagedHeight": 10,

10

 "PackagedLength": 10,

11

 "PackagedWidth": 10,

12

 "PackagedWeightKg": 10,

13

 "Height": null,

14

 "Length": null,

15

 "Width": null,

16

 "WeightKg": null,

17

 "CubicWeight": 0.1667,

18

 "IsKit": false,

19

 "CreationDate": null,

20

 "RewardValue": null,

21

 "EstimatedDateArrival": null,

22

 "ManufacturerCode": "123",

23

 "CommercialConditionId": 1,

24

 "MeasurementUnit": "un",

25

 "UnitMultiplier": 2.0000,

26

 "ModalType": null,

27

 "KitItensSellApart": false,

28

 "Videos": [ "https://www.youtube.com/" ]

29

}

`

#### **Request body example (automatically generated ID)**

`1

{

2

 "ProductId": 310117069,

3

 "IsActive": false,

4

 "ActivateIfPossible": true,

5

 "Name": "sku test",

6

 "RefId": "125478",

7

 "Ean": "8949461894984",

8

 "PackagedHeight": 10,

9

 "PackagedLength": 10,

10

 "PackagedWidth": 10,

11

 "PackagedWeightKg": 10,

12

 "Height": null,

13

 "Length": null,

14

 "Width": null,

15

 "WeightKg": null,

16

 "CubicWeight": 0.1667,

17

 "IsKit": false,

18

 "CreationDate": null,

19

 "RewardValue": null,

20

 "EstimatedDateArrival": null,

21

 "ManufacturerCode": "123",

22

 "CommercialConditionId": 1,

23

 "MeasurementUnit": "un",

24

 "UnitMultiplier": 2.0000,

25

 "ModalType": null,

26

 "KitItensSellApart": false,

27

 "Videos": [ "https://www.youtube.com/" ]

28

}

`

#### **Response body example**

`1

{

2

 "Id":1,

3

 "ProductId": 310117069,

4

 "IsActive": false,

5

 "ActivateIfPossible": true,

6

 "Name": "sku test",

7

 "RefId": "125478",

8

 "Ean": "8949461894984",

9

 "PackagedHeight": 10,

10

 "PackagedLength": 10,

11

 "PackagedWidth": 10,

12

 "PackagedWeightKg": 10,

13

 "Height": null,

14

 "Length": null,

15

 "Width": null,

16

 "WeightKg": null,

17

 "CubicWeight": 0.1667,

18

 "IsKit": false,

19

 "CreationDate": null,

20

 "RewardValue": null,

21

 "EstimatedDateArrival": null,

22

 "ManufacturerCode": "123",

23

 "CommercialConditionId": 1,

24

 "MeasurementUnit": "un",

25

 "UnitMultiplier": 2.0000,

26

 "ModalType": null,

27

 "KitItensSellApart": false,

28

 "Videos": [ "https://www.youtube.com/" ]

29

}

`

## Updating an SKU

After an SKU has been successfully created, if any changes are needed or if it's necessary to [activate it manually](#manual-activation), use the [Update SKU endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/stockkeepingunit/-skuId-).

#### **Request body example**

`1

{

2

 "Id": 70,

3

 "ProductId": 42,

4

 "IsActive": true,

5

 "Name": "Size 10",

6

 "RefId": "B096QW8Y8Z",

7

 "PackagedHeight": 15.0,

8

 "PackagedLength": 15.0,

9

 "PackagedWidth": 15.0,

10

 "PackagedWeightKg": 15.0,

11

 "Height": null,

12

 "Length": null,

13

 "Width": null,

14

 "WeightKg": null,

15

 "CubicWeight": 0.0,

16

 "IsKit": false,

17

 "CreationDate": "2020-01-25T15:51:00",

18

 "RewardValue": null,

19

 "EstimatedDateArrival": null,

20

 "ManufacturerCode": null,

21

 "CommercialConditionId": 1,

22

 "MeasurementUnit": "un",

23

 "UnitMultiplier": 1.0,

24

 "ModalType": null,

25

 "KitItensSellApart": false,

26

 "Videos": []

27

}

`

#### **Response body example**

`1

{

2

 "Id": 70,

3

 "ProductId": 42,

4

 "IsActive": true,

5

 "Name": "Size 10",

6

 "RefId": "B096QW8Y8Z",

7

 "PackagedHeight": 15.0,

8

 "PackagedLength": 15.0,

9

 "PackagedWidth": 15.0,

10

 "PackagedWeightKg": 15.0,

11

 "Height": null,

12

 "Length": null,

13

 "Width": null,

14

 "WeightKg": null,

15

 "CubicWeight": 0.0,

16

 "IsKit": false,

17

 "CreationDate": "2020-01-25T15:51:00",

18

 "RewardValue": null,

19

 "EstimatedDateArrival": null,

20

 "ManufacturerCode": null,

21

 "CommercialConditionId": 1,

22

 "MeasurementUnit": "un",

23

 "UnitMultiplier": 1.0,

24

 "ModalType": null,

25

 "KitItensSellApart": false,

26

 "Videos": []

27

}

`

## Activating an SKU

Before you can activate an SKU, it must meet the following requirements:

* The SKU must have at least one of the following alternate IDs configured: `RefId` or `EAN`.
* The SKU must have at least one image associated. To associate an image to an SKU, use the [Create SKU file endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit/-skuId-/file).
* If the SKU has [specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications), they must be filled in.
* If the field `ActivateIfPossible` is `false`, the SKU must be activated manually. For more information, check the [Manual activation](#manual-activation) section.
* If the SKU is a [kit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunitkit), it must have at least one component active.
* The SKU must be associated with an active product, which, in turn, must be associated with an active Brand and an active Category.

Once the SKU complies with all the aspects listed above, there are two ways that you can activate your SKU - [manually](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku%23manual-activation) or [automatically](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku%23automatic-activation). Read the following sections for more details.

> Note that additional configurations are necessary for a product and its SKUs to become visible in a store:
>
> * Having registered a price for the SKU in the associated trade policy (also known as sales channel). Read the Pricing onboarding guide for more information on this process.
> * Having at least one unit in stock. Read the Fulfillment onboarding guide for more information on managing inventory.
> * Configuring your storefront's CMS to display products correctly, as described in this Frequently Asked Question.

### Manual activation

To manually activate your SKU, follow these steps:

1. [Create the SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit), setting `IsActive` as `false` and `ActivateIfPossible` as `false`.
2. If the SKU is a kit, [create and associate SKU components](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-post-sku-kit).
3. [Create and associate SKU files](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit/-skuId-/file).
4. [Update the SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/stockkeepingunit/-skuId-) as active, setting `IsActive` as `true`.

Now the SKU should be active in your store.

### Automatic activation

This configuration will automatically update the SKU as active once it is associated with an image or an active component. You do not need to update the SKU as in the previous steps.

To automatically activate your SKU, follow these steps:

1. [Create the SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit), setting `IsActive` as `false` and `ActivateIfPossible` as `true`.
2. If the SKU is a kit, [create and associate SKU components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunitkit).
3. [Create and associate SKU files](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit/-skuId-/file).

Now the SKU should be active in your store.

Contributors

3

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7108339%3Fv%3D4%26w=64%26q=75)](https://github.com/brunoamui)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/catalog-integration/skus.md)

[Updating SKU Specifications with Catalog API« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku//docs/guides/updating-sku-specifications-with-catalog-api)[ImagesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku//docs/guides/images)

Contributors

3

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7108339%3Fv%3D4%26w=64%26q=75)](https://github.com/brunoamui)

ON THIS PAGE

[Creating an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus%23creating-an-sku)

[Updating an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus%23updating-an-sku)

[Activating an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus%23activating-an-sku)

[Manual activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus%23manual-activation)[Automatic activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus%23automatic-activation)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/catalog-integration/skus.md)

Copy page

On this page

ON THIS PAGE

[Creating an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus%23creating-an-sku)

[Updating an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus%23updating-an-sku)

[Activating an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus%23activating-an-sku)

[Manual activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus%23manual-activation)[Automatic activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus%23automatic-activation)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)