[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 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.badges/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.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.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.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.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.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.badges/updates/release-notes)

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtexarg.abtester)

[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.abandoned-cart-service)

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

[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.broadcaster)

[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.catalog-images)

[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.checkout-ui-custom)

[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.checkout-ui-settings)

[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.messages)

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

[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtexbr.pickup-selector)

[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.rewriter)

[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.responsive-values)

[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.search-graphql)

[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.session-client)

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

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

[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.telemarketing)

[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/guides/assembly-options-app)

[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/guides/affiliates-program-app)

---

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

---

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

---

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

---

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

---

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

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

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

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

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

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

---

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

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtexarg.abtester)

[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.abandoned-cart-service)

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

[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.broadcaster)

[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.catalog-images)

[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.checkout-ui-custom)

[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.checkout-ui-settings)

[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.messages)

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

[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtexbr.pickup-selector)

[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.rewriter)

[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.responsive-values)

[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.search-graphql)

[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.session-client)

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

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

[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.telemarketing)

[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/guides/assembly-options-app)

[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/guides/affiliates-program-app)

---

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

---

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

---

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

---

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

---

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

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

Badges

Official extension

Version: 3.10.3

Latest version: 3.10.3

> This app is no longer maintained by VTEX. This means it will not be updated, and support and maintenance are no longer provided.

This app allows you to add content badges to an ecommerce. In the Admin panel, you can create, edit, and remove badges. There is also a storefront component that allows these badges to be added to your store theme.

## Configuration

In order to set up the Badges app in your store, follow these steps:

1. Install the app. You can do this by going to the [Badges app page](https://read.calvincode.net/reader?url=https://apps.vtex.com/vtex-badges/p) in the VTEX app store or by running this command in your terminal:

`1

 vtex install vtex.badges@3.x

`

1. Add **Badges** to the `peerDependencies` in your `manifest.json` file:

`1

"peerDependencies": {

2

 "vtex.badges": "3.x"

3

}

`

With this, you should be able to start using the app.

## Managing badges

After installing the app, you will be able to access it by going to the `OTHER` section of the Admin panel and clicking `Badge Management`.

![{"base64":"  ","img":{"width":1366,"height":768,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":60934,"url":"https://user-images.githubusercontent.com/47991446/176534387-6ce7a70c-3c75-4e19-acf6-3211cfa69555.PNG"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/47991446/176534387-6ce7a70c-3c75-4e19-acf6-3211cfa69555.PNG)

### Creating badges

The `Add badges` tab allows you to create new badges by following these steps:

1. Fill in the name of the badge.
2. Select the badge type, which can be `IMAGE`, `TEXT`, or `HTML`.
3. Insert the badge content according to the selected type.
4. Select the badge priority level, where `1` is the maximum priority and `5` is the minimum.
5. Set up the activation rule, which is composed of one or more conditions.
6. Click `SAVE`.

See below a badge creation example.

![{"base64":"  ","img":{"width":768,"height":721,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":28674,"url":"https://user-images.githubusercontent.com/47991446/176534433-be56d30d-bdf3-4c30-a933-235aba6b1115.PNG"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/47991446/176534433-be56d30d-bdf3-4c30-a933-235aba6b1115.PNG)

> Note that each badge must contain at least one activation rule condition with the verb `is`. The app will not work properly if all activation rules conditions use `is not`.

### Editing badges

To edit an existing badge, go to the `Edit badges` tab and follow these steps:

1. Click the menu icon in the row corresponding to the badge you wish to edit.
2. Click `Edit`.
3. Edit the badge attributes.
4. Click `EDIT`.

![{"base64":"  ","img":{"width":870,"height":377,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":18900,"url":"https://user-images.githubusercontent.com/47991446/176534410-67fac67e-3ae5-40ef-96a0-e8fabb09f2bb.PNG"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/47991446/176534410-67fac67e-3ae5-40ef-96a0-e8fabb09f2bb.PNG)

### Deleting badges

If you wish to delete an existing badge from your store, go to the `Edit badges` tab and follow these steps:

1. Click the menu icon in the row corresponding to the badge you wish to edit.
2. Click `Delete`.
3. In the prompt that will be displayed, click `DELETE`.

### Filtering badges

To improve the search for badges, it is possible to select which fields you want the search for them to be filtered. This makes searching the Database simpler and more efficient when returning badges to your website. To configure it, just enter the My Applications area. Then choose **App Badges** and select which fields you want the search to be related to.

![{"base64":"  ","img":{"width":1870,"height":1478,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":174631,"url":"https://user-images.githubusercontent.com/80836180/203373595-aef6bf9b-de00-43a5-b2fd-0636b97c2fb5.png"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/80836180/203373595-aef6bf9b-de00-43a5-b2fd-0636b97c2fb5.png)

Remember that by default, all fields are used as a filter.

## Displaying badges in your store

In order to display the created badges in your store, you must add the `store-badges` component to a product page (`store.product`) or a `product-summary`. See an example of how to add badges to a product page below.

`1

 "store.product": {

2

 "children": [

3

+ "store-badges",

4

 "stack-layout",

5

 "breadcrumb",

6

 "flex-layout.row#main",

7

 "condition-layout.product"

8

 ]

9

 },

10

11

+ "store-badges":{

12

+ "props": {

13

+ "numberOfBadges": 1,

14

+ "text":{

15

+ "font": "t-heading-5",

16

+ "textColor": "blue",

17

+ "textAlignment": "CENTER",

18

+ "textPosition": "CENTER",

19

+ "htmlId": "teste1"

20

+ },

21

+ "image":{

22

+ "blockClass": "container",

23

+ "height": 500,

24

+ "width": 500,

25

+ "minWidth": 25,

26

+ "minHeight": 25,

27

+ "alt": "teste",

28

+ "title": "title",

29

+ "preload": true

30

+ }

31

+ }

32

+ }

`

### Component props

These are the props available for customization of the badge component.

| Prop name      | Type   | Description                                                                                |
| -------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| numberOfBadges | number | Number of badges that will be rendered.                                                                                |
| text           | array  | Defines values that will be used when rendering a badge. To learn more about this prop, see [Rich text](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/rich-text).         |
| image          | array  | Defines values that will be used when rendering image badges. To learn more about this prop, see [Store image](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-image) |

## Final result

After finishing all the steps, you can check the result in your store. The order of the badges is set according to the priority defined when creating them. See the image below that corresponds to the badge setup in this tutorial's examples.

![{"base64":"  ","img":{"width":798,"height":533,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":115953,"url":"https://user-images.githubusercontent.com/47991446/176911546-14dd3e5b-2af7-4f66-bd9e-2cd2c154cd09.PNG"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/47991446/176911546-14dd3e5b-2af7-4f66-bd9e-2cd2c154cd09.PNG)

[Abandoned Cart Service« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.abandoned-cart-service)[BroadcasterNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.broadcaster)

See also

[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)[README\_ptVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.badges@3.10.3/README%5Fpt)

ON THIS PAGE

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

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

[Creating badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.badges%23creating-badges)[Editing badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.badges%23editing-badges)[Deleting badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.badges%23deleting-badges)[Filtering badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.badges%23filtering-badges)

[Displaying badges in your store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.badges%23displaying-badges-in-your-store)

[Component props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.badges%23component-props)

[Final result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.badges%23final-result)

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 faststore getting started faststore versions and support levels 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/getting-started-faststore-versions-and-support-levels/docs/guides)

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

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

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

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/getting-started-with-storefront-solutions)

---

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

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/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/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-overview)

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

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/storefront-features-overview)

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

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

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/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/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/api-extensions-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/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/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

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

---

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

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

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/vtex-io-apps)

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

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/getting-started-with-storefront-solutions)

---

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

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/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/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-overview)

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

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/storefront-features-overview)

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

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

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/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/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/api-extensions-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/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/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

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

---

[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/storefront-development)

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

FastStore versions and support levels

Understand FastStore versions, support levels, and guidance for upgrading.

FastStore has two main versions: FastStore v1 and FastStore v2+. This document outlines the key differences between these versions, their support levels, and guidelines for upgrading.

## FastStore v1

[FastStore v1](https://read.calvincode.net/reader?url=https://v1.faststore.dev/docs) was the first version of the framework. While it served as the foundation for FastStore, it's no longer actively maintained. New projects must use the latest version of FastStore.

## FastStore v2+

FastStore v2+ is the latest and most advanced version of the storefront solution. It encompasses all versions starting from v2 and introduces major improvements over FastStore v1, such as:

* **Simplified updates:** Stores are monitored for version updates with minimal friction, including automatic non-critical updates and a more efficient integration process.
* **Separation of VTEX-managed code and store customizations:** Clear segmentation between VTEX and custom code to help in the debug process.
* **CMS-first approach:** Headless CMS manages content updates (texts, images, links) while behavioral and UI component changes remain code-based, ensuring a structured workflow.
* **Optimized performance and quality monitoring:** Ongoing performance tracking with proactive safeguards to prevent deployments that don’t meet Lighthouse and quality standards.
* **Semantic versioning:** FastStore v2+ uses [Semantic Versioning](https://read.calvincode.net/reader?url=https://semver.org/) for managing releases:
   * **Majors:** Introduce breaking changes, including incompatible API updates.
   * **Minors:** Introduce backward-compatible features.
   * **Patches:** Include backward-compatible bug fixes.

## Key differences between FastStore versions

One of the main changes from FastStore v1 to FastStore v2+ is the separation between VTEX code and store-specific customizations. This separation introduced the [core](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview%23packagejson) package for VTEX code and reserved the `/src` folder for store-specific customizations. Below are the key differences between the versions:

### Packages

| Package name  | FastStore v1 | FastStore v2 | FastStore v3 |
| ------------- | ------------ | ------------ | ------------ |
| api           | ✅            | ✅            | ✅            |
| cli           | ✅            | ✅            | ✅            |
| components    | ✅            | ✅            | ✅            |
| core          | ❌            | ✅            | ✅            |
| graphql-utils | ✅            | ✅            | ✅            |
| lighthouse    | ✅            | ✅            | ✅            |
| sdk           | ✅            | ✅            | ✅            |
| styles        | ✅            | ❌            | ❌            |
| ui            | ✅            | ✅            | ✅            |

### Other aspects

| **Aspect**                | **FastStore v1**                                                                 | **FastStore v2**                                                       | **FastStore v3**                                                                                |
| ------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| **Documentation**         | [FastStore v1 Portal](https://read.calvincode.net/reader?url=https://v1.faststore.dev/)                                 | [Developers Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore) | [Developers Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore)                             |
| **Project onboarding**    | [Cloning the FastStore starter repository](https://read.calvincode.net/reader?url=https://v1.faststore.dev/quickstart). | Onboarding app                                                         | [WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project) |
| **Development framework** | [Gatsby](https://read.calvincode.net/reader?url=https://www.gatsbyjs.com/docs/) / [Next.js](https://read.calvincode.net/reader?url=https://nextjs.org/docs)    | [Next.js](https://read.calvincode.net/reader?url=https://nextjs.org/docs)                                     | [Next.js](https://read.calvincode.net/reader?url=https://nextjs.org/docs)                                                                 |

## Support levels

Different levels of support are available depending on the FastStore version. The following table details the status, support availability, and recommendations for each version of new projects.

| **Criteria**     | **FastStore v1**                                                                          | **FastStore v2+**                                   |
| ---------------- | ----------------------------------------------------------------------------------------- | --------------------------------------------------- |
| **Status**       | No longer updated.                                                                        | Actively maintained.                                |
| **Support**      | Limited support. Only bugs and vulnerabilities related to public VTEX APIs are addressed. | Full support.                                       |
| **New Projects** | Not supported. Only FastStore v2+ is available for new projects.                          | Recommended for all new storefront implementations. |

If you have any questions about the level of support provided for different FastStore versions, [open a ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support) with the VTEX Support team.

## Upgrade between FastStore versions

Before upgrading to a new FastStore version, contact VTEX to ensure compatibility and a smooth transition. For assistance, [open a ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support) with the VTEX Support team.

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/_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/getting-started-faststore-versions-and-support-levels/_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/faststore/docs/getting-started/faststore-versions-and-support-levels.mdx)

[FastStore« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore)[Getting StartedNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-overview)

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/_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/getting-started-faststore-versions-and-support-levels/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

ON THIS PAGE

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

[FastStore v2+](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23faststore-v2)

[Key differences between FastStore versions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23key-differences-between-faststore-versions)

[Packages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23packages)[Other aspects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23other-aspects)

[Support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23support-levels)

[Upgrade between FastStore versions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23upgrade-between-faststore-versions)

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/getting-started/faststore-versions-and-support-levels.mdx)

Copy page

On this page

ON THIS PAGE

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

[FastStore v2+](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23faststore-v2)

[Key differences between FastStore versions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23key-differences-between-faststore-versions)

[Packages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23packages)[Other aspects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23other-aspects)

[Support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23support-levels)

[Upgrade between FastStore versions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23upgrade-between-faststore-versions)

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 vtex io documentation messages builder 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/vtex-io-documentation-messages-builder/docs/guides)

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

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

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

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-what-is-vtex-io)

---

[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-what-is-a-vtex-app)

---

[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/governance-and-shared-security-in-vtex-io-apps)

---

[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-getting-started)

---

Project structure

[Manifest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-manifest)

[Billing Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-billing-options)

[Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-builders)

[Admin Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-admin-builder)

[Assets Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-assets-builder)

[Docs Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-docs-builder)

[GraphQL Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-graphql-builder)

[Messages Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-messages-builder)

[Node Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-node-builder)

[PaymentProvider Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-paymentprovider-builder)

[Pixel Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-pixel-builder)

[React Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-react-builder)

[Store Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-store-builder)

[Styles Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-styles-builder)

[Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-dependencies)

[Peer Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-peerdependencies)

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)

---

[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/app-development-guides)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)

---

[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/managing-edition-apps)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides)

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

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

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

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

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/troubleshooting)

---

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

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-what-is-vtex-io)

---

[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-what-is-a-vtex-app)

---

[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/governance-and-shared-security-in-vtex-io-apps)

---

[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-getting-started)

---

Project structure

[Manifest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-manifest)

[Billing Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-billing-options)

[Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-builders)

[Admin Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-admin-builder)

[Assets Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-assets-builder)

[Docs Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-docs-builder)

[GraphQL Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-graphql-builder)

[Messages Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-messages-builder)

[Node Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-node-builder)

[PaymentProvider Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-paymentprovider-builder)

[Pixel Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-pixel-builder)

[React Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-react-builder)

[Store Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-store-builder)

[Styles Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-styles-builder)

[Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-dependencies)

[Peer Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-peerdependencies)

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)

---

[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/app-development-guides)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)

---

[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/managing-edition-apps)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

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

Project structure

[Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-builders)

[Messages Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-messages-builder)

Messages builder

Learn how to use the VTEX IO Messages builder.

The `messages` builder handles the internationalization (i18n) of strings in VTEX IO apps using [React](https://read.calvincode.net/reader?url=https://react.dev/). Instead of declaring static strings in frontend components, this builder allows you to use an ID for each message, which will be dynamically replaced with the corresponding string in the user's language.

For more information about creating apps that support multiple languages, see [7\. Translating the component in the Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component) and [Internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores).

## Folder structure

The `messages` builder uses a folder named `messages` located in the app's root folder. This folder contains one JSON file for each language used in the app. Each file is named using the corresponding two lowercase letters of the language's [ISO 639-1 code](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php). For instance, English is represented by the code `en`, Spanish by `es`, and Portuguese by `pt`.

`1

messages

2

┣ 📄en.json

3

┣ 📄es.json

4

┗ 📄pt.json

`

* `{language-code}.json`: JSON file of the language containing the message IDs with their corresponding strings. See file name examples below:
   * `en.json`: JSON file for English messages.
   * `es.json`: JSON file for Spanish messages.
   * `pt.json`: JSON file for Portuguese messages.

## Usage

To develop an app using the `messages` builder, follow the steps below:

1. **Start with a React app**: First, you need an app that uses the [react builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-builder). If you are starting from scratch, you can download the [React app boilerplate](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/react-app-template/tree/master/react).
2. **Add the React i18n libraries**: Open a terminal in the `react` folder of your app and run the following command: `yarn add react-intl@3 && yarn add @types/react-intl@3 --dev`.
3. **Configure the manifest**: Access the `manifest.json` file and add the `messages` builder to the builders list.
manifest.json
`1
{
2
 ...
3
 "builders": {
4
 "react": "3.x",
5
 "docs": "0.x",
6
+ "messages": "1.x"
7
 },
8
 ...
9
}
`
4. **Add the message identifiers:** Use the string identifiers in your React code. In the example below, `store/my-app.hello` is a string identifier for the `<Formatted Message>` component. Keys that start with `store/` are used in the storefront, while keys that start with `admin/` are used in the Admin UI. If a string identifier is used in the code and does not have a corresponding key in the message JSON files, it will fallback to the [automatic translation service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores%23automatic-translations).
`1
import React from 'react'
2
import { FormattedMessage } from 'react-intl'
3

4
const HelloWorld = () => {
5
 return (
6
 <div>
7
 <FormattedMessage id="store/my-app.hello"/>
8
 </div>
9
 )
10
}
11

12
export default HelloWorld
`
> Use meaningful and descriptive keys for all strings. Maintain a consistent naming convention that reflects the context and location of the text. This practice helps developers and translators locate the keys, understand their meaning, and organize the strings.
5. **Add the messages files with strings:** Create a separate JSON file for each language in the `messages` folder. In each file, define an object where the keys are the message IDs and the values are the corresponding strings in the target language. Each key must be present in every JSON file. See the examples below for English, Spanish, and Portuguese.
en.json
`1
{
2
 "store/my-app.hello": "Hello, world!"
3
}
`
es.json
`1
{
2
 "store/my-app.hello": "¡Hola, mundo!"
3
}
`
pt.json
`1
{
2
 "store/my-app.hello": "Olá, mundo!"
3
}
`
> We recommend adding the keys to the JSON files in alphabetical order. This helps developers and translators to locate and work with the keys.

Contributors

1

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

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/vtex-io/Reference/concepts/vtex-io-documentation-builders/vtex-io-documentation-messages-builder.md)

[GraphQL Builder« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder//docs/guides/vtex-io-documentation-graphql-builder)[Node BuilderNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder//docs/guides/vtex-io-documentation-node-builder)

Contributors

1

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

ON THIS PAGE

[Folder structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-messages-builder%23folder-structure)

[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-messages-builder%23usage)

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/vtex-io/Reference/concepts/vtex-io-documentation-builders/vtex-io-documentation-messages-builder.md)

Copy page

On this page

ON THIS PAGE

[Folder structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-messages-builder%23folder-structure)

[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-messages-builder%23usage)

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 pii data architecture 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/pii-data-architecture/docs/guides)

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

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

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/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/pii-data-architecture/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

---

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

[PII Data Architecture specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/pii-data-architecture-specifications)

[Data residency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/data-residency)

[Profile System integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/profile-system)

[Working with schemas in the Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/working-with-schemas-in-the-profile-system)

[Changes in VTEX features behavior to handle PII data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data)

[Limitations of the PII data architecture during closed beta](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/limitations-of-the-pii-data-architecture-during-closed-beta)

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/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/pii-data-architecture/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

---

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

[PII Data Architecture specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/pii-data-architecture-specifications)

[Data residency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/data-residency)

[Profile System integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/profile-system)

[Working with schemas in the Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/working-with-schemas-in-the-profile-system)

[Changes in VTEX features behavior to handle PII data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data)

[Limitations of the PII data architecture during closed beta](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/limitations-of-the-pii-data-architecture-during-closed-beta)

---

Weni by VTEX

---

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

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

Data Protection Plus

> **Closed beta:** [Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-protection-plus) is in closed beta and is only available in select regions.

> This feature is part of [VTEX Shield](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh), meaning _additional fees may apply._
>
> If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ).
>
> If you are not yet a customer but are interested in this solution, please complete our [contact form](https://read.calvincode.net/reader?url=https://vtex.com/us-en/contact/).

The VTEX platform allows stores to process shoppers' Personal Identifiable Information (PII) in compliance with data privacy regulations such as [GDPR and LGPD](https://read.calvincode.net/reader?url=https://vtex.com/us-en/privacy-and-agreements/vtex-commitment/).

When using Data Protection Plus, accounts follow the PII data architecture, where all PII is stored in the [Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system). Other VTEX modules, such as **Order Management** and **Checkout**, store only pseudonymized data associated with a **Profile System** token. These modules may also access PII from the **Profile System**, as described in the [PII data architecture specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications).

> See the [Trust Hub](https://read.calvincode.net/reader?url=https://vtex.com/us-en/trust/) to learn more about VTEX's vision regarding data privacy, including certifications, internal policies and commitments.

## Solutions and implementation

VTEX has established a comprehensive PII data architecture that incorporates a range of solutions and processes for PII. See the documentation below to learn more about how it works and how to implement it.

* [PII Data Architecture specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications): Technical specifications of the PII data architecture, including the Profile System, data encryption and auditability, among other key features.
* [Data residency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency): How PII data residency works for VTEX stores using the PII data architecture.
* [Data subject rights](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/data-subject-rights--6imchxTx09icupKMbzHVIM): Detailed instructions on how VTEX stores can apply data subject rights.
* [Profile System integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system): How to integrate with the Profile System API.
* [Working with schemas in the Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system): How to interact with the structure of data stored in the Profile System.
* [Changes in VTEX features behavior to handle PII data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data): Adaptations in the default behavior of certain VTEX features to handle the PII data architecture.
* [Limitations of the PII data architecture during closed beta](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/limitations-of-the-pii-data-architecture-during-closed-beta): Current limitations that apply to stores using PII data architecture, in relation to certain VTEX features.
* [Erasing customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erasing-customer-data): Process to erase customer data when using the PII data architecture.

## Parties' responsibilities

VTEX isolates and protects all fields classified as sensitive. However, it is important to acknowledge that there are scenarios beyond VTEX's control. In such cases, as a VTEX client, it is the store's responsibility to ensure the integrity of your integrations and prevent any data misuse. The main scenarios to consider include:

* Sending PII in custom or text fields.
* Adhering to IO apps that depend on or consume PII data.
* Integrating with third-party systems that consume PII data, such as ERPs.

Contributors

1

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

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/data-privacy/data-protection-plus.md)

[Revoking SSL private certificates when using Mutual Transport Layer Security (mTLS)« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture//docs/guides/revoking-ssl-private-certificates-when-using-mtls)[PII Data Architecture specificationsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture//docs/guides/pii-data-architecture-specifications)

See also

[PII Data Architecture specificationsGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/pii-data-architecture-specifications)[Data residencyGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/data-residency)[Changes in VTEX features behavior to handle PII dataGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data)[Profile System integrationGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/profile-system)[Erasing customer dataGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/erasing-customer-data)[Limitations of the PII data architecture during closed betaGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/limitations-of-the-pii-data-architecture-during-closed-beta)

Contributors

1

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

ON THIS PAGE

[Solutions and implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/data-protection-plus%23solutions-and-implementation)

[Parties' responsibilities](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/data-protection-plus%23parties-responsibilities)

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/data-privacy/data-protection-plus.md)

Copy page

On this page

ON THIS PAGE

[Solutions and implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/data-protection-plus%23solutions-and-implementation)

[Parties' responsibilities](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/data-protection-plus%23parties-responsibilities)

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