[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 synchronizing inventory information 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/synchronizing-inventory-information/docs/guides)

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

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

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

---

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

[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/getting-started-with-vtex-ads-api)

[Synchronizing the catalog with VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/synchronizing-the-catalog-with-vtex-ads)

[Synchronizing product information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/synchronizing-product-information)

[Synchronizing inventory information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/synchronizing-inventory-information)

[Retrieving ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/retrieving-ads)

[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/ads-events)

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

---

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

[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/getting-started-with-vtex-ads-api)

[Synchronizing the catalog with VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/synchronizing-the-catalog-with-vtex-ads)

[Synchronizing product information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/synchronizing-product-information)

[Synchronizing inventory information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/synchronizing-inventory-information)

[Retrieving ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/retrieving-ads)

[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/ads-events)

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/getting-started-with-vtex-ads-api)

[Synchronizing the catalog with VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/synchronizing-the-catalog-with-vtex-ads)

[Synchronizing inventory information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/synchronizing-inventory-information)

Synchronizing inventory information

Ensure inventory availability data is kept up to date for ad display.

Inventory information defines the price, promotional price, and "stock." Regarding stock, we should only receive whether the product is available for sale.

Learn more about each field on `POST` [Synchronize inventory information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-ads-api%23post-/product/bulk/inventories).

> 🚧 Batch Insert / Update
>
> For each batch insert/update, a maximum of 500 objects per request and 3 simultaneous requests are allowed.
>
> Therefore, for an initial load with the entire product base, this limit must be taken into account when sending data.

### Request

Processing will be performed asynchronously.

`1

POST https://api-retail-media.newtail.com.br/product/bulk/inventories HTTP/1.1

2

accept: application/json

3

content-type: application/json

4

x-app-id: <PUBLISHER_APP_ID>

5

x-api-key: <API_KEY>

6

7

[

8

 {

9

 "product_sku": "120210",

10

 "store_id": "1",

11

 "price": 18.20,

12

 "promotional_price": 16.32,

13

 "is_available": true

14

 },

15

 {

16

 "product_sku": "120212",

17

 "price": 18.20,

18

 "promotional_price": 0, // this removes the promotional price

19

 "is_available": true

20

 }

21

]

`

### Response with validation error

For validations, we use the [RFC 8927](https://read.calvincode.net/reader?url=https://datatracker.ietf.org/doc/rfc8927/) format, as exemplified below.

> A failed response will have HTTP code 422.

`1

[

2

 {

3

 "instancePath": "/0",

4

 "schemaPath": "#/items/required",

5

 "keyword": "required",

6

 "params": {

7

 "missingProperty": "product_sku"

8

 },

9

 "message": "must have required property 'product_sku'"

10

 },

11

 {

12

 "instancePath": "/0",

13

 "schemaPath": "#/items/required",

14

 "keyword": "required",

15

 "params": {

16

 "missingProperty": "promotional_price"

17

 },

18

 "message": "must have required property 'promotional_price'"

19

 }, {

20

 "instancePath": "/0",

21

 "schemaPath": "#/items/required",

22

 "keyword": "required",

23

 "params": {

24

 "missingProperty": "is_available"

25

 },

26

 "message": "must have required property 'is_available'"

27

 },

28

 {

29

 "instancePath": "/1",

30

 "schemaPath": "#/items/required",

31

 "keyword": "required",

32

 "params": {

33

 "missingProperty": "price"

34

 },

35

 "message": "must have required property 'price'"

36

 }, {

37

 "instancePath": "/1",

38

 "schemaPath": "#/items/required",

39

 "keyword": "required",

40

 "params": {

41

 "missingProperty": "promotional_price"

42

 },

43

 "message": "must have required property 'promotional_price'"

44

 },

45

 {

46

 "instancePath": "/1",

47

 "schemaPath": "#/items/required",

48

 "keyword": "required",

49

 "params": {

50

 "missingProperty": "is_available"

51

 },

52

 "message": "must have required property 'is_available'"

53

 }, {

54

 "instancePath": "/2",

55

 "schemaPath": "#/items/required",

56

 "keyword": "required",

57

 "params": {

58

 "missingProperty": "price"

59

 },

60

 "message": "must have required property 'price'"

61

 },

62

 {

63

 "instancePath": "/2",

64

 "schemaPath": "#/items/required",

65

 "keyword": "required",

66

 "params": {

67

 "missingProperty": "is_available"

68

 },

69

 "message": "must have required property 'is_available'"

70

 }

71

]

`

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/_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/VTEX Ads/getting-started-with-vtex-ads-api/synchronizing-the-catalog-with-vtex-ads/synchronizing-inventory-information.md)

[Synchronizing product information« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information//docs/guides/synchronizing-product-information)[Retrieving adsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information//docs/guides/retrieving-ads)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/_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

[Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/synchronizing-inventory-information%23request)

[Response with validation error](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/synchronizing-inventory-information%23response-with-validation-error)

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 Ads/getting-started-with-vtex-ads-api/synchronizing-the-catalog-with-vtex-ads/synchronizing-inventory-information.md)

Copy page

On this page

ON THIS PAGE

[Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/synchronizing-inventory-information%23request)

[Response with validation error](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/synchronizing-inventory-information%23response-with-validation-error)

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 migrating storefront from legacy to io 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-migrating-storefront-from-legacy-to-io/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/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-migrating-storefront-from-legacy-to-io/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-migrating-storefront-from-legacy-to-io/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-migrating-storefront-from-legacy-to-io/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-migrating-storefront-from-legacy-to-io/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-migrating-storefront-from-legacy-to-io/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/faststore)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/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/vtex-io-documentation-migrating-storefront-from-legacy-to-io/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/vtex-io-documentation-migrating-storefront-from-legacy-to-io/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/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/list-of-controls-for-templates)

[Setting up the zoom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/setting-up-the-zoom)

[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/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/vtex-io-documentation-migrating-storefront-from-legacy-to-io/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/vtex-io-documentation-migrating-storefront-from-legacy-to-io/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/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/how-product-name-control-works)

[Configure the price history control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/configure-the-price-history-control)

[Shelf template controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/shelf-template-controls)

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

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/app-development)

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

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/troubleshooting)

---

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

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/faststore)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/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/vtex-io-documentation-migrating-storefront-from-legacy-to-io/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/vtex-io-documentation-migrating-storefront-from-legacy-to-io/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/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/list-of-controls-for-templates)

[Setting up the zoom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/setting-up-the-zoom)

[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/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/vtex-io-documentation-migrating-storefront-from-legacy-to-io/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/vtex-io-documentation-migrating-storefront-from-legacy-to-io/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/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/how-product-name-control-works)

[Configure the price history control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/configure-the-price-history-control)

[Shelf template controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/shelf-template-controls)

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

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/storefront-best-practices)

---

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

(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/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io)

Migrating your storefront from Legacy CMS Portal to Store Framework

VTEX provides different storefront solutions for you to choose from based on your operation’s needs: [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-store-framework) and [FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs-what-is-faststore). However, there are still stores running the [Legacy CMS Portal](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/1oN446gRGcR2s70RvBCAmj).

If your store uses Legacy CMS Portal, we strongly recommend migrating it to Store Framework. For implementation details, see the following sections.

> If you wish to migrate your store from another commerce platform, the instructions below do not apply. In this case, follow the steps in the [Go Live guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live).

## Instructions

To migrate your store from Legacy CMS Portal to [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-store-framework), follow these steps:

1. [Setup workspaces](#step-1-setting-up-workspaces)
2. [Develop and test](#step-2-developing-and-testing-your-storefront)
3. [Go live](#step-3-going-live)

> Consider planning the entire go-live process at least two weeks in advance, as some of the steps below are time-sensitive.

### Step 1 - Setting up workspaces

[Workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace) are isolated environments, which means they can be understood as different versions of the same VTEX account.

To develop and test your store, we recommend that you create at least one [development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace) and one [production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace). But it may be a good idea to create more workspaces based on your development needs. Learn how to manage workspaces effectively in [Best practices on workspaces management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices).

> Do not use subaccounts instead of [workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace). This can cause loss of Master Data information, including client profiles, and delays in project changes being displayed on the storefront due to cache unpredictability. It may even cause store downtime when going live with the new storefront.

#### Setting the Edition app

Once you have created your workspaces, [open a support ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support) requesting the installation of the `vtex.edition-store@3.x` or a more recent version of the [Edition app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app) in the workspaces created previously. Do not forget to include the names of the workspaces you wish to use in this process.

To check which version of the Edition app is installed in a workspace, run the following command: `vtex edition get`. Learn about its different versions in the [Edition app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app) guide.

> Do not request the Edition change for the master workspace of your store. This will cause some features, such as My Account, to stop working properly.

### Step 2 - Developing and testing your storefront

At this point, it is up to your development team to plan and develop your store’s frontend experience. Check these guides to learn how to use VTEX IO to create amazing storefronts with [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-store-framework):

* [CMS IO basic concepts](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/4yB9wSl79cArd68aRBnBZ2)
* [Storefront implementation overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation)
* [Storefront apps overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-apps)
* [Building a Store Framework theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3)

### Step 3 - Going live

Once you have developed and tested your new storefront and everything is ready in a production workspace, it is time to go live. This means seamlessly switching the storefront being displayed to shoppers at your store’s domain. Follow these steps to accomplish this task:

1. Promote the production workspace running your new storefront to master. Learn more about how to [promote a workspace to master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master).
2. Request VTEX internal DNS pointing change for Store Framework via [support ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support). Use the ticket to schedule the change according to the information below at least three business days before your planned go-live date. This last step will cause your new storefront to go live.

When opening the ticket, keep in mind that you must:

* Open the ticket at least 3 days before the go-live date.
* Request VTEX internal DNS pointing change only after you have promoted your production workspace to master.
* Make it clear that you wish to go live in the ticket title.
* Indicate a time from 9 a.m. to 5 p.m. (UTC-3) for the change to happen.
* Indicate whether your store has any [trade policy conditional rules](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/criar-uma-politica-comercial--563tbcL0TYKEKeOY4IAgAE).

Contributors

4

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F112641072%3Fv%3D4%26w=64%26q=75)](https://github.com/barbara-celi)

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

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/_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/vtex-io-documentation-migrating-storefront-from-legacy-to-io/_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/vtex-io/Storefront-Guides/vtex-io-documentation-going-live/vtex-io-documentation-migrating-storefront-from-legacy-to-io.md)

[Installing apps on live stores« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io//docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices)[Can I order my product as I want?Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io//docs/guides/can-i-order-my-product-as-i-want)

Contributors

4

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F112641072%3Fv%3D4%26w=64%26q=75)](https://github.com/barbara-celi)

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

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/_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/vtex-io-documentation-migrating-storefront-from-legacy-to-io/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

ON THIS PAGE

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io%23instructions)

[Step 1 - Setting up workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io%23step-1-setting-up-workspaces)[Step 2 - Developing and testing your storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io%23step-2-developing-and-testing-your-storefront)[Step 3 - Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io%23step-3-going-live)

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/Storefront-Guides/vtex-io-documentation-going-live/vtex-io-documentation-migrating-storefront-from-legacy-to-io.md)

Copy page

On this page

ON THIS PAGE

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io%23instructions)

[Step 1 - Setting up workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io%23step-1-setting-up-workspaces)[Step 2 - Developing and testing your storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io%23step-2-developing-and-testing-your-storefront)[Step 3 - Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io%23step-3-going-live)

On this page

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


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

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

[Assistant]
Documentation

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

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

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

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

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

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

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

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

Storefront Development

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

---

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

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

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

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

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

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

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

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

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

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

[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/analytics-overview)

[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/cart-overview)

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

[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/session-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/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/sdk-overview/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/sdk-overview/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/sdk-overview/docs/guides/faststore/managing-performance-overview)

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

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

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

---

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

---

(Legacy) CMS Portal

---

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

---

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

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

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

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

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

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

---

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

Storefront Development

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

---

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

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

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

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

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

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

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

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

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

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

[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/analytics-overview)

[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/cart-overview)

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

[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/session-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/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/sdk-overview/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/sdk-overview/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/sdk-overview/docs/guides/faststore/managing-performance-overview)

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

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

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

---

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

---

(Legacy) CMS Portal

---

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

---

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

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

FastStore SDK

The FastStore SDK is a toolkit that provides functions and interfaces for managing the state of key ecommerce features in the browser context. Providing a set of functions and interfaces simplifies tasks like tracking cart items and handling user sessions.

The SDK is organized into four modules with specific properties and behaviors. This track provides more details about each module.

* [Cart](#cart)
* [Session](#session)
* [Search](#search)
* [Analytics](#analytics)
* [Getting started with the FastStore SDK](#getting-started-with-the-faststore-sdk)
   * [Usage](#usage)
   * [Inspecting browser data](#inspecting-browser-data)

## Cart

The Cart module controls the state of the shopping cart data structure in the shopper's browser. You can use it to add items to the cart, remove items, and clear the cart, among other tasks. To learn more about this module, see the [Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview) guide.

> Learn more about validating the cart in the shopper browser against the information in the platform with [FastStore API mutations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations%23cart).

## Session

The Session module manages the state of session information in the shopper browser. This includes currency, channel, localization, and shopper information. To learn more about this module, see the [Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-session) data structure and usage.

> Learn more about validating the cart in the shopper browser against the information in the platform with [FastStore API mutations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations%23session).

## Search

The Search module offers functions for implementing a faceted search based on URL parameters. Whenever a shopper searches your store or changes the selected facets, the search module generates a unique and serialized URL and then directs the user to that URL. To learn more about this module, see the [Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-overview) section.

## Analytics

The Analytics module helps you create a simple, extensive event system to feed your data pool. It is geared towards [Google Analytics 4](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4) but supports other analytics providers. To learn more about this module, see the [Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview) section.

## Getting started with the FastStore SDK

Install [@faststore/sdk](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview%23packagejson) as a dependency of your FastStore project via the command line:

### Usage

The FastStore SDK makes available different functions and hooks to manage essential ecommerce features. To use these functions and hooks, import them from the `@faststore/sdk` package.

The following example demonstrates how to manage a shopping cart using the `useCart` hook. It focuses on adding an item to the cart and displaying the cart's contents.

In the example, if the cart is empty, it shows a message indicating that the cart is empty. However, if the cart contains items, it lists each item's name, price, and quantity.

`1

yarn add @faststore/sdk

`

### Inspecting browser data

You can inspect browser data related to the session and shopping cart managed by the SDK when running your project locally. To do that, follow these steps:

1. Run the command `yarn dev` from the root of your FastStore project.
2. Open your local project preview at `http://localhost:3000`.
3. Open the browser's developer console and run the following commands:
   * To view session data: `faststore_sdk_stores.get("fs::session").read()`.
   * To view shopping cart data: `faststore_sdk_stores.get("fs::cart").read()`.

Contributors

1

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

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/sdk/overview.mdx)

[Configuring GraphQL cache control for GET requests« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/faststore-api-configuring-graphql-cache-control)[AnalyticsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/analytics-overview)

Contributors

1

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

ON THIS PAGE

[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview%23cart)

[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview%23session)

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

[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview%23analytics)

[Getting started with the FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview%23getting-started-with-the-faststore-sdk)

[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview%23usage)[Inspecting browser data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview%23inspecting-browser-data)

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/sdk/overview.mdx)

Copy page

On this page

ON THIS PAGE

[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview%23cart)

[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview%23session)

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

[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview%23analytics)

[Getting started with the FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview%23getting-started-with-the-faststore-sdk)

[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview%23usage)[Inspecting browser data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview%23inspecting-browser-data)

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

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

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

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

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

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

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

[Working with schemas in the Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/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/data-residency/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/data-residency/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/data-residency/docs/guides)

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

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

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

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

[Working with schemas in the Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/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/data-residency/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/data-residency/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/data-residency/docs/guides)

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

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

Data residency

> **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 data residency feature enables stores implementing [Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-protection-plus) to select the specific geographic region where all data saved in the [Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system) is stored, such as name, email, and shipping address, among others.

It is possible to choose the data residency location from two available options:

* **AWS us-east-1:** located in Virginia, USA.
* **AWS eu-west-1:** located in Ireland.

There are two instances of the [Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system) running in parallel, each based in different locations: US (Virginia) and EU (Ireland). These instances are identical in terms of their functioning. However, each instance only holds and processes data associated with stores that selected that location as their accounts' PII data residency. Profile System information is backed up in the same selected region, using [Amazon DynamoDB Point-in-time recovery (PITR)](https://read.calvincode.net/reader?url=https://aws.amazon.com/dynamodb/pitr).

In practice, when data is requested from the [Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system), the VTEX edge layer directs the request to the appropriate Profile System location based on the data residency location selected by the account, as illustrated below.

AWS eu-west-1

AWS us-east-1

Database

Storage entity

Router

VTEX service

Storage entity

Database

> The [Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system) is the VTEX module responsible for keeping Shopper Profile PII at rest.

Contributors

2

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

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

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

[PII Data Architecture specifications« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency//docs/guides/pii-data-architecture-specifications)[Profile System integrationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency//docs/guides/profile-system)

See also

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

Contributors

2

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

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

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

Copy page

On this 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] Provide a guide on guides vtex iframe 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-iframe/docs/guides)

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

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

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

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

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

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

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

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

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

---

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

Iframe

An app that makes it possible to render external iframes on a store.

![{"base64":"  ","img":{"width":354,"height":636,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":184249,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-iframe-0.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-iframe-0.png)

## Configuration - standard Iframe

1. Add the `vtex.iframe` to the theme's dependencies on the `manifest.json`

`1

"dependencies": {

2

 "vtex.iframe": "0.x"

3

}

`

1. Add the interface `iframe` to any **custom page** (Iframes are not allowed outside custom pages).

`1

{

2

 "store.custom#about-us": {

3

 "blocks": [

4

 "flex-layout.row#about-us",

5

 "iframe"

6

 ]

7

 },

8

9

 "iframe": {

10

 "props": {

11

 "src": ""

12

 }

13

 }

14

}

`

| Prop name | Type   | Description                             | Default value |
| --------- | ------ | --------------------------------------- | ------------- |
| src       | String | Source address the iframe should render | null          |
| width     | Number | Width attribute of the iframe           | null          |
| height    | Number | Height attribute of the iframe          | null          |
| allow     | String | allow attribute of the iframe           | null          |

## Configuration - dynamic Iframe

1. Add the `vtex.iframe` to the theme's dependencies on the `manifest.json`

`1

"dependencies": {

2

 "vtex.iframe": "0.x"

3

}

`

1. Add the dynamicIframe block and its properties to the blocks.json file

`1

{

2

 "store.custom#locationPage":{

3

 "children":[

4

 "iframe.dynamic-src"

5

 ]

6

 },

7

 "iframe.dynamic-src":{

8

 "props": {

9

 "dynamicSrc": "https://www.test.com/exampleStaticPathName/{dynamicParam1}/{dynamicParam2}/exampleStaticPageName",

10

 "width": "1920",

11

 "height": "1000",

12

 "title": "exampleStaticPageName iframe wrapper for {account}",

13

 "allow": "geolocation"

14

 }

15

 }

16

}

`

1. register your new page in routes.json with appropriate parameters passed into the page url

`1

{

2

 "store.custom#locationPage":{

3

 "path": "/:param1/:param2/pagename"

4

 }

5

}

`

| Prop name  | Type   | Description                                                       | Default value |
| ---------- | ------ | ----------------------------------------------------------------- | ------------- |
| dynamicSrc | String | iframe src with dynamic parameters from page URL enclosed in '{}' | null          |
| width      | Number | Width attribute of the iframe                                     | null          |
| height     | Number | Height attribute of the iframe                                    | null          |
| title      | String | title attribute of the iframe                                     | null          |
| allow      | String | allow attribute of the iframe                                     | null          |

## Customization

There is a `.container` handle that wraps the iframe, it's also possible to use `blockClass`.

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-iframe/_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/vtex-io/Store-Framework-Apps/advanced-components/vtex-iframe.md)

Contributors

1

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

ON THIS PAGE

[Configuration - standard Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-iframe/docs/guides/vtex-iframe%23configuration-standard-iframe)

[Configuration - dynamic Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-iframe/docs/guides/vtex-iframe%23configuration-dynamic-iframe)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-iframe/docs/guides/vtex-iframe%23customization)

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/Store-Framework-Apps/advanced-components/vtex-iframe.md)

Copy page

On this page

ON THIS PAGE

[Configuration - standard Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-iframe/docs/guides/vtex-iframe%23configuration-standard-iframe)

[Configuration - dynamic Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-iframe/docs/guides/vtex-iframe%23configuration-dynamic-iframe)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-iframe/docs/guides/vtex-iframe%23customization)

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