[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 clear orderform message field from cart 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/clear-orderform-message-field-from-cart/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/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/clear-orderform-message-field-from-cart/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/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/clear-orderform-message-field-from-cart/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/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/clear-orderform-message-field-from-cart/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/checkout-api-overview)

[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/custom-data-1)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/customization)

[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/discounts)

[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/features)

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/orders-2)

[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/checkout-security)

[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/shopping-cart-section-api-quick-start-guides)

[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/cart-attachments-section-api-quick-start-guides)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/configuration-section-api-quick-start-guides)

[Getting an account orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/get-an-account-orderform-configuration)

[Updating an account orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/update-an-account-orderform-configuration)

[Get and update the seller exchange window](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/get-and-update-the-seller-exchange-window)

[Clear orderForm message field from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/clear-orderform-message-field-from-cart)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)

[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/region-section-api-quick-start-guides)

[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/checkout-error-codes)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/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/clear-orderform-message-field-from-cart/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/checkout-api-overview)

[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/custom-data-1)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/customization)

[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/discounts)

[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/features)

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/orders-2)

[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/checkout-security)

[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/shopping-cart-section-api-quick-start-guides)

[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/cart-attachments-section-api-quick-start-guides)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/configuration-section-api-quick-start-guides)

[Getting an account orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/get-an-account-orderform-configuration)

[Updating an account orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/update-an-account-orderform-configuration)

[Get and update the seller exchange window](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/get-and-update-the-seller-exchange-window)

[Clear orderForm message field from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/clear-orderform-message-field-from-cart)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)

[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/region-section-api-quick-start-guides)

[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/checkout-error-codes)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/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/clear-orderform-message-field-from-cart/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides)

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/checkout-api-overview)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/configuration-section-api-quick-start-guides)

[Clear orderForm message field from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/clear-orderform-message-field-from-cart)

Clearing the orderForm message field from the cart

The orderForm is the main object processed by VTEX Checkout and one of the most important data structures in the architecture of every VTEX store. It stores a lot of contextual information about the order, which is essential for processing order information, such as order items, customer personal information, delivery address, and shipping information.

This guide will describe how to remove all messages from the `messages` field of the orderForm, leaving it empty.

## Removing all messages from the orderForm message field

To remove all messages from the orderForm `messages` field of the shopping cart, you need to use the [Clear orderForm messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForm/-orderFormId-/messages/clear) endpoint. The `orderFormId` information of the shopping cart must be sent through the URL request, as in the example below:

`https://{accountname}.{environment.com.br}/api/checkout/pub/orderForm/ede846222cd44046ba6c638442c3505a/messages/clear`

Additionally, you need to send the request body containing only two curly brackets, as shown below:

`1

{}

`

After sending the request, the endpoint will return the response body containing the shopping cart information and the `messages` field will empty, as in the example below:

`1

2

"messages": [],

`

> For more information about the meaning of each field available in the shopping cart, please refer to the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) overview.

## Error codes

The following errors may appear as messages in the response body:

### 400 - Bad Request

* **Message error example (code 001)**: `"Bad Request"`. This message indicates that information other than `{}` was sent in the request body.

`1

{

2

 "fields": {},

3

 "error": {

4

 "code": "001",

5

 "message": "Bad request",

6

 "exception": null

7

 },

8

 "operationId": "91b68251-1a60-4716-b846-c7c9c31fa565"

9

}

`

* **Message error example (code ORD002)**: `"Carrinho inválido"` (_Invalid Cart_). This message indicates that the `orderFormId` used in the request does not exist or is incorrect.

`1

{

2

 "fields": {},

3

 "error": {

4

 "code": "ORD002",

5

 "message": "Carrinho inválido",

6

 "exception": null

7

 },

8

 "operationId": "5d37a185-bfe6-4686-9d92-aac9482cc63d"

9

}

`

### 404 - Not Found

* **Message error example**: `"The requested URL was not found on the server"`: check if the URL is correct.

`1

2

404 Not Found

3

The requested URL was not found on this server.

4

`

Contributors

4

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/_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/clear-orderform-message-field-from-cart/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F25390429%3Fv%3D4%26w=64%26q=75)](https://github.com/karenkrieger)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/_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/clear-orderform-message-field-from-cart/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F87548049%3Fv%3D4%26w=64%26q=75)](https://github.com/ricardoaerobr)

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/Checkout/configuration-section-api-quick-start-guides/clear-orderform-message-field-from-cart.md)

[Get and update the seller exchange window« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart//docs/guides/get-and-update-the-seller-exchange-window)[FulfillmentNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart//docs/guides/fulfillment-checkout-section-api-quick-start-guides)

Contributors

4

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/_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/clear-orderform-message-field-from-cart/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F25390429%3Fv%3D4%26w=64%26q=75)](https://github.com/karenkrieger)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/_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/clear-orderform-message-field-from-cart/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F87548049%3Fv%3D4%26w=64%26q=75)](https://github.com/ricardoaerobr)

ON THIS PAGE

[Removing all messages from the orderForm message field](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/clear-orderform-message-field-from-cart%23removing-all-messages-from-the-orderform-message-field)

[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/clear-orderform-message-field-from-cart%23error-codes)

[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/clear-orderform-message-field-from-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/clear-orderform-message-field-from-cart%23404-not-found)

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/Checkout/configuration-section-api-quick-start-guides/clear-orderform-message-field-from-cart.md)

Copy page

On this page

ON THIS PAGE

[Removing all messages from the orderForm message field](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/clear-orderform-message-field-from-cart%23removing-all-messages-from-the-orderform-message-field)

[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/clear-orderform-message-field-from-cart%23error-codes)

[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/clear-orderform-message-field-from-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/clear-orderform-message-field-from-cart%23404-not-found)

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 control to disable the canonical tag 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/control-to-disable-the-canonical-tag/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/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/control-to-disable-the-canonical-tag/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/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/control-to-disable-the-canonical-tag/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/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/control-to-disable-the-canonical-tag/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/faststore)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/store-framework)

---

(Legacy) CMS Portal

[Migrating your storefront from Legacy CMS Portal to Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io)

[Can I order my product as I want?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/can-i-order-my-product-as-i-want)

[List of controls for templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/list-of-controls-for-templates)

[Setting up the zoom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/setting-up-the-zoom)

[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/creating-gift-lists)

[Validating a layout before moving it to production](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/validating-a-layout-before-moving-it-to-production)

[How to use the page title control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/how-to-use-the-page-title-control)

[How product name control works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/how-product-name-control-works)

[Configure the price history control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/configure-the-price-history-control)

[Shelf template controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/shelf-template-controls)

[Control to disable the canonical tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/control-to-disable-the-canonical-tag)

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/faststore)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/store-framework)

---

(Legacy) CMS Portal

[Migrating your storefront from Legacy CMS Portal to Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io)

[Can I order my product as I want?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/can-i-order-my-product-as-i-want)

[List of controls for templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/list-of-controls-for-templates)

[Setting up the zoom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/setting-up-the-zoom)

[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/creating-gift-lists)

[Validating a layout before moving it to production](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/validating-a-layout-before-moving-it-to-production)

[How to use the page title control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/how-to-use-the-page-title-control)

[How product name control works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/how-product-name-control-works)

[Configure the price history control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/configure-the-price-history-control)

[Shelf template controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/shelf-template-controls)

[Control to disable the canonical tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/control-to-disable-the-canonical-tag)

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/storefront-best-practices)

---

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/storefront-development)

(Legacy) CMS Portal

[Control to disable the canonical tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/control-to-disable-the-canonical-tag)

Control to disable the canonical tag

## What is the canonical tag

When using the meta tags control, explained in the article [How to use the meta tags control](how-to-use-the-meta-tags-control), one of the tags inserted in the head of the page is the **canonical tag**:

`<link rel="canonical" href="http://{AccountName}.com.br/{page}">`

The canonical tag allows you to avoid **duplicate content**, that is, scenarios where two pages of the site display identical or almost identical content. An example are the following three URLs:

* {AccountName}.com
* {AccountName}.com.br
* {AccountName}.com/

All of the above URLs display the same content, but for search engines, simply adding a forward slash to the end of the address may characterize a different page, which is bad for **SEO** purposes.

To avoid scenarios like that, the canonical tag informs search engines what is the preferred version of a web page.

So a search engine can decide whether two pages have duplicate content and, if it decides they do, transfer the indexing merits to the preferred version.

## Disabling the canonical tag for a page

While the canonical tag is useful for SEO purposes, you may not want to use it for specific pages.

Because it's inserted automatically by the meta tag control, if you are using this control, you must inform the system that it should exclude only the canonical tag. This is done through the following control:

`<vtex.cmc:canonicalPage disable="true"/>`

Contributors

1

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

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/legacy-cms/control-to-disable-the-canonical-tag.md)

[Shelf template controls« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag//docs/guides/shelf-template-controls)[Storefront best practicesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag//docs/guides/storefront-best-practices)

Contributors

1

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

ON THIS PAGE

[What is the canonical tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/control-to-disable-the-canonical-tag%23what-is-the-canonical-tag)

[Disabling the canonical tag for a page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/control-to-disable-the-canonical-tag%23disabling-the-canonical-tag-for-a-page)

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/legacy-cms/control-to-disable-the-canonical-tag.md)

Copy page

On this page

ON THIS PAGE

[What is the canonical tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/control-to-disable-the-canonical-tag%23what-is-the-canonical-tag)

[Disabling the canonical tag for a page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/control-to-disable-the-canonical-tag%23disabling-the-canonical-tag-for-a-page)

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] How do I use the VTEX product specification badges app? Provide documentation and configuration details.

[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/apps/vtex.product-specification-badges/docs/guides)

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

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

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

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

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/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/apps/vtex.product-specification-badges/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/advanced-components)

[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.availability-notify)

[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.category-menu)

[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtexbr.kitlook)

[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-icons/iconpack)

[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.iframe)

[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtexventures.livestreaming)

[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.connector-paypal-commerce-platform)

[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtexventures.personal-shopper-free)

[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-availability)

[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-comparison)

[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-gifts)

[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtexarg.product-highlight-by-vtex-segment)

[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-specification-badges)

[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtexarg.quantity-on-cart)

[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.reviews-and-ratings)

[Querying personal MasterData Information with SafeData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.safedata)

[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.seller-selector)

[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.similar-products-variants)

[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-drawer)

[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-locator)

[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-form)

[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-link)

[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-media)

[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-newsletter)

[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-video)

[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.sandbox)

[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.shipping-option-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/functional-apps)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/vtex-io-deprecated-apps)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/storefront-development)

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

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/advanced-components)

[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.availability-notify)

[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.category-menu)

[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtexbr.kitlook)

[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-icons/iconpack)

[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.iframe)

[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtexventures.livestreaming)

[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.connector-paypal-commerce-platform)

[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtexventures.personal-shopper-free)

[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-availability)

[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-comparison)

[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-gifts)

[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtexarg.product-highlight-by-vtex-segment)

[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-specification-badges)

[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtexarg.quantity-on-cart)

[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.reviews-and-ratings)

[Querying personal MasterData Information with SafeData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.safedata)

[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.seller-selector)

[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.similar-products-variants)

[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-drawer)

[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-locator)

[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-form)

[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-link)

[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-media)

[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-newsletter)

[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-video)

[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.sandbox)

[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.shipping-option-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/functional-apps)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/vtex-io-deprecated-apps)

---

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

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/advanced-components)

VTEX Product Specification Badges

Official extension

Version: 0.4.1

Latest version: 0.4.1

[![{"base64":"  ","img":{"width":110,"height":20,"type":"svg","mime":"image/svg+xml","wUnits":"px","hUnits":"px","url":"https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square"}}](https://read.calvincode.net/reader?url=https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-)

Use this component to show badges based on your product specifications inside your product page.

### Configuration

This component must be configured to be able to display the specifications properly. Its props can be configured via `blocks.json` and they are:

| Prop name               | Type                                                  | Description                                                                                | Default value |
| ----------------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| blockClass              | string                                                | Allows to pass a custom name to be added to component css classes                                                                                | null          |
| displayValue            | SPECIFICATION\_NAME or SPECIFICATION\_VALUE or string | Choose the value that will appear if the specification condition is met and the badge will be showed. Pass SPECIFICATION\_NAME if you want to display the specification name. Pass SPECIFICATION\_VALUE if you want to display its value. Pass any other custom string to display it. | null          |
| multipleValuesSeparator | string                                                | Define the separator string to be rendered when a specification value has multiple values.                                                                                | /             |
| orientation             | vertical or horizontal                                | Determines if the group of specifications are showed horizontally or vertically                                                                                | vertical      |
| specificationGroupName  | String                                                | The name of the specification group in which the desired specifications are                                                                                | ""            |
| specificationName       | String                                                | Pass the name of the specification you want to target. If left empy, will target all of the group                                                                                | ""            |
| specificationsOptions   | Array<Option>                                         | Pass this if you want to control the conditions to show certain specifications. Each value of the array should be a valid object of the Option format.                                                                                | null          |
| visibleWhen             | String                                                | Pass this if you want the specification to be displayed only if it has this exact value. If left empty, the badge will be showed regardless of the specification value.                                                                                | ""            |

`Option` type:

| Prop name         | Type                                                  | Description                                                                                | Default value |
| ----------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| displayValue      | SPECIFICATION\_NAME or SPECIFICATION\_VALUE or string | Choose the value that will appear if the option condition is met and the badge will be showed. Pass SPECIFICATION\_NAME if you want to show the specification name. Pass SPECIFICATION\_VALUE if you want to show its value. Pass any other custom string to show it. | null          |
| specificationName | String                                                | Pass the name of the specification you want to target. If empty, option will not be checked.                                                                                | ""            |
| visibleWhen       | string                                                | Pass this if you want this option to be applied when the specification has the exactly same value as specified in visibleWhen. If left empty, the badge will be showed regardless of the specification value.                                                         | null          |

**Important note:**

All products come with a default `allSpecifications` group, that is a group that combines all specifications in your product. If you manually create another group and add a specification in it, this specification will also appear in the `allSpecifications` group. So, if you want to apply your conditions to all specification, regardless of group, you must pass the value `allSpecifications`.

### Example 1

Let's say your product has this specification groups:

`1

// specificationGroups array

2

[

3

 {

4

 "name": "Group",

5

 "specifications": [

6

 {

7

 "name": "On Sale",

8

 "values": ["True"]

9

 }

10

 ]

11

 },

12

 {

13

 "name": "Group 2",

14

 "specifications": [

15

 {

16

 "name": "Demo",

17

 "values": ["True"]

18

 },

19

 {

20

 "name": "PromoExclusion",

21

 "values": ["1"]

22

 }

23

 ]

24

 },

25

 {

26

 "name": "allSpecifications",

27

 "specifications": [

28

 {

29

 "name": "On Sale",

30

 "values": ["True"]

31

 },

32

 {

33

 "name": "Demo",

34

 "values": ["True"]

35

 },

36

 {

37

 "name": "PromoExclusion",

38

 "values": ["1"]

39

 }

40

 ]

41

 }

42

]

`

If you want to display all specifications with the value `True`, you could then pass:

`1

"product-specification-badges": {

2

 "props": {

3

 "specificationGroupName": "allSpecifications",

4

 "displayValue": "SPECIFICATION_NAME",

5

 "visibleWhen": "True"

6

 }

7

 },

`

In this case, it will appear the `On Sale` and `Demo` badges (because you passed the `SPECIFICATION_NAME` in `displayValue`).

### Example 2

Using the specification groups from example 1, we can get the same result with the specificationOptions prop:

`1

 "product-specification-badges": {

2

 "props": {

3

 "specificationGroupName": "allSpecifications",

4

 "specificationsOptions": [{

5

 "specificationName": "On Sale",

6

 "displayValue": "SPECIFICATION_NAME",

7

 "visibleWhen": "True"

8

 },

9

 {

10

 "specificationName": "Demo",

11

 "displayValue": "SPECIFICATION_NAME",

12

 "visibleWhen": "True"

13

 }]

14

 }

15

 },

`

### Example 3

`1

// specificationGroups array

2

[

3

 {

4

 "name": "Group",

5

 "specifications": [

6

 {

7

 "name": "On Sale",

8

 "values": ["True"]

9

 }

10

 ]

11

 },

12

 {

13

 "name": "Group 2",

14

 "specifications": [

15

 {

16

 "name": "Demo",

17

 "values": ["True"]

18

 },

19

 {

20

 "name": "PromoExclusion",

21

 "values": ["1"]

22

 }

23

 ]

24

 },

25

 {

26

 "name": "allSpecifications",

27

 "specifications": [

28

 {

29

 "name": "On Sale",

30

 "values": ["True"]

31

 },

32

 {

33

 "name": "Demo",

34

 "values": ["My Cool Value"]

35

 },

36

 {

37

 "name": "PromoExclusion",

38

 "values": ["1"]

39

 }

40

 ]

41

 }

42

]

`

If you want to show the value for the `Demo` specification, you could pass:

`1

 "product-specification-badges": {

2

 "props": {

3

 "specificationGroupName": "allSpecifications",

4

 "specificationsOptions": [{

5

 "specificationName": "On Sale",

6

 "displayValue": "SPECIFICATION_NAME",

7

 "visibleWhen": "True"

8

 },

9

 {

10

 "specificationName": "Demo",

11

 "displayValue": "SPECIFICATION_VALUE",

12

 }]

13

 }

14

 },

`

Final result: will appear the `On Sale` badge and a badge with `My Cool Value`.

Note the use of `SPECIFICATION_VALUE` in `displayValue` and the lack of `visibleWhen` in `Demo`.

### Example 4

Using the example given in example 3.

To show a custom string you could do:

`1

 "product-specification-badges": {

2

 "props": {

3

 "specificationGroupName": "allSpecifications",

4

 "specificationsOptions": [{

5

 "specificationName": "On Sale",

6

 "displayValue": "SPECIFICATION_NAME",

7

 "visibleWhen": "True"

8

 },

9

 {

10

 "specificationName": "Demo",

11

 "displayValue": "SPECIFICATION_VALUE",

12

 },

13

 {

14

 "specificationName": "PromoExclusion",

15

 "displayValue": "Cool Promo",

16

 }]

17

 }

18

 },

`

Final result: will appear the `On Sale` badge, a badge with `My Cool Value` and a badge with the string `Cool Promo`.

Note the usage of a custom value in the `displayValue` config.

### Usage tip

You can use our `stack-layout` to show the badges over your product image for example.

`1

 "stack-layout": {

2

 "children": [

3

 "product-images",

4

 "product-specification-badges"

5

 ]

6

 },

7

8

 "product-specification-badges": {

9

 "props": {

10

 "specificationGroupName": "allSpecifications",

11

 "displayValue": "SPECIFICATION_NAME",

12

 "specificationName": "On Sale",

13

 "visibleWhen": "True"

14

 }

15

 },

16

 "flex-layout.row#product-image": {

17

 "children": ["product-images"]

18

 },

`

### CSS API

| CSS class      | Description                                 |
| -------------- | ------------------------------------------- |
| groupContainer | Container that wrapps the whole badge group |
| badgeContainer | Container for each badge                    |
| badgeText      | Text displayed inside badge                 |

Note: each badge receives a class `badgeContainer` with its specification name slug appended to it. Example: with the specification `On Sale: true` the badge will also have the class `badgeContainer--on-sale`.

Note: each badge receives a class `badgeText` with its specification value slug appended to it. Example: with the specification `Nationality: Brazilian` the badge will also have the class `badgeText--brazilian`.

[Product Highlight by VTEX Segment« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtexarg.product-highlight-by-vtex-segment)[Quantity On CartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtexarg.quantity-on-cart)

See also

[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)

ON THIS PAGE

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-specification-badges%23configuration)

[Example 1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-specification-badges%23example-1)[Example 2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-specification-badges%23example-2)[Example 3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-specification-badges%23example-3)[Example 4](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-specification-badges%23example-4)[Usage tip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-specification-badges%23usage-tip)[CSS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-specification-badges%23css-api)

Was this helpful?

[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 managing skus 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/managing-skus/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/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/managing-skus/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/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/managing-skus/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/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/managing-skus/updates/release-notes)

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

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

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

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

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

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

---

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

Managing SKUs

Learn how to create, update, and activate an SKU with the Catalog API.

This step-by-step guide will walk you through the process of creating, updating, and activating a [Stock Keeping Unit (SKU)](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/3mJbIqMlz6oKDmyZ2bKJoA%23) within the VTEX platform. An SKU represents a specific item in the inventory that customers can purchase, essentially serving as a unique product variation, such as a "long sleeve gray size S shirt."

## Before you begin

Before you begin managing your SKUs, make sure you've completed the following steps:

* **Create a Product**: Your SKUs should be associated with an existing product. If you haven't created a product yet, refer to the [Product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/products) for more information.
* **Obtain API Credentials**: Ensure you have a valid `appKey` and `appToken` with the necessary permissions to access the [Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api). For more information, please refer to the [Roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) article.

> Click the steps below to navigate through this article and explore specific topics. Relevant code will be highlighted and focused for your convenience. Additionally, in the code viewer on the right, you can switch between different code files or tabs to view the corresponding code examples.

## Creating an SKU

Send a request to the [Create SKU endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit) to create a new SKU, considering the following points when building the request body:

* `IsActive`: Ensure that `IsActive` is set to `false`. Activating it during creation will result in a `400 Bad Request` error.
* `ActivateIfPossible`: It's recommended to set `ActivateIfPossible` as `true,` unless you plan to have an internal workflow to [manually activate SKUs](#manual-activation).
* **Alternate IDs**: Provide at least one of the following IDs in the request body: `RefId` or `EAN`. You can also provide both if necessary.

When sending the request body, you can specify the desired SKU `Id` or let VTEX automatically generate it, as presented in the following.

### Custom `Id`: Request body

If there is a need to create a new SKU with a specific custom `Id`, specify the `Id` (`integer`) in the request body.

### Automatically generated ID: Request body

If there's no need to specify a custom `Id`, you can omit it from the request body, and VTEX will automatically generate the `Id`.

## Updating an SKU

After successfully creating an SKU, you can update its details by sending a request to the [Update SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/stockkeepingunit/-skuId-) endpoint. To update an SKU, provide the SKU's unique `skuId` in the URL and include the updated information in the request body.

## Activating an SKU

Activating an SKU means making it available for purchase in your store, allowing customers to browse, search, and buy the associated product. To be activated, ensure your SKU meets the following requirements:

* **Alternate IDs**: The SKU must have at least one of the following alternate IDs configured: `RefId` or `EAN`.
* **Image**: The SKU must have at least one image associated with it. 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) to associate an image to an SKU.
* **Specifications**: If the SKU has [specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications), they must be filled in.
* **Kit**: For [kit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunitkit) SKUs, at least one component must be active.
* **Product**: The SKU must be associated with an active product, which, in turn, must be related to an active [Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands) and an active [Category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories).

Once the SKU meets these requirements, you can activate it using one of the following methods: [automatic](#automatic-activation) or [manual](#manual-activation).

### Automatic activation

If your SKU's `IsActive` is set to `false` and `ActivateIfPossible` is set to `true`, your SKU will automatically become active as soon as it is associated with an image or an active component.

Here's an overview of the necessary steps to implement automatic SKU activation:

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

### Manual activation

If your SKU's `IsActive` is set to `false` and `ActivateIfPossible` is set to `false`, send a request to the [Update the SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/stockkeepingunit/-skuId-) endpoint, setting `IsActive` as `true`.

Here's an overview of the necessary steps to implement manual SKU activation:

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

Shell

Python

Node.js

`1

curl --request post \

2

 --url https://{accountName}.vtexcommercestable.com.br/api/catalog/pvt/stockkeepingunit \

3

 --header 'Accept: application/json' \

4

 --header 'Content-Type: application/json' \

5

 --header 'X-VTEX-API-AppKey: {appKey}' \

6

 --header 'X-VTEX-API-AppToken: {appToken}' \

7

 --data '{body}'

`

Body

Response

`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.0,

26

 "ModalType": null,

27

 "KitItensSellApart": false,

28

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

29

}

`

> Note that additional configurations are necessary for a product and its SKUs to become visible in a store:
>
> * Register a price for the SKU in the associated trade policy (sales channel). Refer to the [Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-overview) guide for more information.
> * Ensure you have at least one unit in stock. Manage your inventory by following the [Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment) guide.
> * Configure your storefront to display products correctly.

Contributors

1

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

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/Catalog/managing-skus.mdx)

Contributors

1

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

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides/managing-skus%23before-you-begin)

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

[Custom Id: Request body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides/managing-skus%23custom-id-request-body)[Automatically generated ID: Request body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides/managing-skus%23automatically-generated-id-request-body)

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

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

[Automatic activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides/managing-skus%23automatic-activation)[Manual activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides/managing-skus%23manual-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/Catalog/managing-skus.mdx)

Copy page

On this page

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides/managing-skus%23before-you-begin)

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

[Custom Id: Request body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides/managing-skus%23custom-id-request-body)[Automatically generated ID: Request body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides/managing-skus%23automatically-generated-id-request-body)

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

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

[Automatic activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides/managing-skus%23automatic-activation)[Manual activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides/managing-skus%23manual-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=)