[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 managing performance testing server side rendering 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/managing-performance-testing-server-side-rendering/docs/guides)

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

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

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

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore)

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

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/headless-cms-overview)

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

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/faststore-api-overview)

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

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

[Testing server-side rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/managing-performance-testing-server-side-rendering)

[Improving store performance with Preact](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/managing-performance-improving-store-performance-with-preact)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore)

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

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/headless-cms-overview)

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

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/faststore-api-overview)

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

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

[Testing server-side rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/managing-performance-testing-server-side-rendering)

[Improving store performance with Preact](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/managing-performance-improving-store-performance-with-preact)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/storefront-best-practices)

---

[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/storefront-development)

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/managing-performance-overview)

Testing server-side rendering

JavaScript handles data fetching, templating, and routing on the client-side rather than on the server-side. However, the amount of JavaScript shipped to the browser tends to increase as the complexity of an application grows. As a result, JavaScript code competes for processing power and delays the rendering task because it keeps trying to be processed before the browser finishes rendering the page content.

To ensure your server-side rendering (SSR) HTML is functional and free of bugs, it is important to check how your web page looks and behaves when JavaScript is disabled.

## Instructions

1. Check the documentation of your web browser and search for how to disable JavaScript. For example, if you are using Google Chrome, check Google's documentation on [Disabling JavaScript](https://read.calvincode.net/reader?url=https://developers.google.com/web/tools/chrome-devtools/javascript/disable).
2. Access your store website and check if its [core features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started%23vtex-core-services), such as product searching, shopping cart, and checkout process are working as expected. Your store will not function exactly as planned, but check below which are the expected and undesired behaviors when disabling JavaScript:
   * **Undesired behaviors**
         * The page does not render anything.
         * Instead of updating only the different content, the page is fully refreshed when navigating to another page.
         * Misplaced layout.
   * **Expected behaviors**
         * Simpler design, displaying basic layout similar to a static webpage.
         * Animations and interactive menus do not work.
         * The below-the-fold content does not render.

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F112641072%3Fv%3D4%26w=64%26q=75)](https://github.com/barbara-celi)

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/managing-performance/testing-server-side-rendering.md)

[Managing performance« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/managing-performance-overview)[Improving store performance with PreactNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/managing-performance-improving-store-performance-with-preact)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F112641072%3Fv%3D4%26w=64%26q=75)](https://github.com/barbara-celi)

ON THIS PAGE

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/managing-performance-testing-server-side-rendering%23instructions)

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/managing-performance/testing-server-side-rendering.md)

Copy page

On this page

ON THIS PAGE

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/managing-performance-testing-server-side-rendering%23instructions)

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 checkout api 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/checkout-api-overview/docs/guides)

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

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

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

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

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

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

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

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

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

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

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

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/configuration-section-api-quick-start-guides)

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

[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/region-section-api-quick-start-guides)

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

---

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

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

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

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

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

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

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

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

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

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

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/configuration-section-api-quick-start-guides)

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

[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/region-section-api-quick-start-guides)

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

---

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

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

Checkout API - Overview

>  Check the new [Checkout onboarding guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/checkout-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about the Checkout and is organized by focusing on the developer's journey.

The Checkout API allows you to obtain and configure information about the shopping cart and its attachments, personalization of custom fields, orderForm structure, fulfillment data, order management, and identification of the sellers delivery region.

**Important**: Data modification operations (`POST`, `PATCH`, `PUT` or `DELETE` endpoints) shall not be performed in parallel in the Checkout APIs. They need to be enqueued by the client/requester. Otherwise, old values can be overwritten incorrectly or competition errors may occur."

## Shopping cart

Allows merchants to simulate, configure and customize shopping cart information.

* [POST - Cart Simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/cartsimulation)
* [GET - Get current or create a new cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/orderForm)
* [GET - Get cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getcartinformationbyid)
* [POST - Remove all items](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/removeallitems)
* [GET - Remove all personal data](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/removeallpersonaldata)
* [POST - Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/itemsupdate)
* [POST - Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/items)
* [PUT - Change price](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/pricechange)
* [PATCH - Ignore profile data](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/ignoreprofiledata)
* [GET - Cart installments](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getcartinstallments)
* [POST - Add coupons to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addcoupons)

## Cart attachments

Allows merchants to obtain client profiles and add information to a given shopping cart.

* [GET - Get client profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getclientprofilebyemail)
* [POST - Add client profile](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addclientprofile)
* [POST - Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addshippingaddress)
* [POST - Add client preferences](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addclientpreferences)
* [POST - Add marketing data](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addmarketingdata)
* [POST - Add payment data](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addpaymentdata)
* [POST - Add merchant context data](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addmerchantcontextdata)

## Custom data

Allows merchants to manage custom fields that were created by an app in their account.

* [PUT - Set multiple custom field values](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/setmultiplecustomfieldvalues)
* [PUT - Set single custom field value](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/setsinglecustomfieldvalue)
* [DELETE - Remove single custom field value](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/removesinglecustomfieldvalue)

## Configuration

Allows merchants to configure orderForm in the account and seller exchange on a given order.

* [GET - Get orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getorderformconfiguration)
* [POST - Update orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/updateorderformconfiguration)
* [GET - Get window to change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getwindowtochangeseller)
* [POST - Update window to change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/updatewindowtochangeseller)
* [POST - Clear orderForm messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/clearorderformmessages)

## Fulfillment

Allows merchants to obtain pickup points and address information.

* [GET - List pickup points by location](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/listpickupppointsbylocation)
* [GET - Get address by postal code](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getaddressbypostalcode)

## Order placement

Allows merchants to place and process orders by creating a new cart or using an existing cart.

* [POST - Place order from an existing cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/placeorderfromexistingorderform)
* [PUT - Place order](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/placeorder)
* [POST - Process order](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/processorder)

## Region

Allows merchants to obtain a list of sellers serving a specific delivery region.

* [GET - Get sellers by region or address](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/regions/-regionId-)

Contributors

2

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

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/_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/Checkout/checkout-api-overview.md)

[How to implement product color variation« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview//docs/guides/how-to-implement-product-color-variation)[Custom DataNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview//docs/guides/custom-data-1)

Contributors

2

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

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

ON THIS PAGE

[Shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/checkout-api-overview%23shopping-cart)

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

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

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

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

[Order placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/checkout-api-overview%23order-placement)

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

Was this helpful?

 Send feedback

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

Copy page

On this page

ON THIS PAGE

[Shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/checkout-api-overview%23shopping-cart)

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

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

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

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

[Order placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/checkout-api-overview%23order-placement)

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

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 dynamic content step 2 handling the dynamic content in custom sections 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/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/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/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/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/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/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/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore)

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

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-overview)

[Managing content with 'scopes' and 'requiredScopes'](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes)

[Multiple page templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-multiple-page-template)

[Previewing Headless CMS in development mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode)

[Widgets for Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-widgets)

[Customizing pages with Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-overview)

[Step 1 - Setting up the store code for Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content)

[Step 2 - Handling Dynamic Content in custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/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/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/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/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/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/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore)

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

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-overview)

[Managing content with 'scopes' and 'requiredScopes'](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes)

[Multiple page templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-multiple-page-template)

[Previewing Headless CMS in development mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode)

[Widgets for Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-widgets)

[Customizing pages with Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-overview)

[Step 1 - Setting up the store code for Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content)

[Step 2 - Handling Dynamic Content in custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/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/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/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/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/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/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/storefront-best-practices)

---

[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/storefront-development)

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-overview)

[Customizing pages with Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-overview)

Step 2 - Handling Dynamic Content in custom sections

After [mapping pages and data-fetching functions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content%23step-1-mapping-pages-and-data-fetching-functions) and choosing one of the methods for [creating Dynamic Content via API fetching](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content%23step-2-creating-dynamic-content-via-api-fetching), use the data to render it in a store section. In this step, we will create a new Hero section, placed on a landing page, to render the image from the data.

| _Before_: Using [Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero) native section with an image uploaded from the Headless CMS.                                                                                | _After:_ Using a custom Hero section fetching the image content from an API.                                                                                |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ![{"base64":"  ","img":{"width":940,"height":631,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":488422,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/without-dynamic-content___9e65e7a095029f020fe64599348b695a.png"}}](https://read.calvincode.net/reader?url=https://vtexhelp.vtexassets.com/assets/docs/src/without-dynamic-content___9e65e7a095029f020fe64599348b695a.png) | ![{"base64":"  ","img":{"width":940,"height":660,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":27256,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/dynamic-content-new-section___82b343ceeef6504de8bdf7233f30d199.png"}}](https://read.calvincode.net/reader?url=https://vtexhelp.vtexassets.com/assets/docs/src/dynamic-content-new-section___82b343ceeef6504de8bdf7233f30d199.png) |

## Before you begin

* Complete the [Step 1 - Setting up your store code for Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content) to set up your store code.
* Make sure your store's Headless CMS includes the following sections in addition to your existing store page sections:
   * **Global**: Includes the global header and footer sections, which are required for all page types.
   * **Children**: Acts as the placeholder for the unique content of each page (including Landing Pages), and it is a mandatory section. Your local build will fail if this section is missing.

For more information, refer to [Sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview%23sections).

## Instructions

### 1\. Creating the section

Create and display a [section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section) for the Dynamic Content. For this tutorial, we’ll create a [Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero).

1. Open your Faststore project.
2. Inside `src`, create the folder `components`.
3. Inside `components`, create a subfolder named `sections`.
4. Inside `sections` create a file called `ProductHero.tsx`, and paste the following code:
src/components/sections/ProductHero.tsx
`1
import {
2
 HeroSection,
3
 getOverriddenSection,
4
 useDynamicContent,
5
} from "@faststore/core";
6
import { ServerDynamicContentQuery } from "@faststore/core/api";
7

8
const OverridenHero = getOverriddenSection({
9
 Section: HeroSection,
10
 components: {
11
 HeroImage: {
12
 Component: CustomHeroImage,
13
 },
14
 },
15
});
16

17
function CustomHeroImage() {
18
 const context = useDynamicContent<ServerDynamicContentQuery>();
19

20
 return (
21
 <img
22
 src={
23
 context.data?.extraData?.customFieldFromRoot ??
24
 "https://via.placeholder.com/350"
25
 }
26
 width={400}
27
 alt={context.data?.extraData?.customField ?? "Hero section image"}
28
 />
29
 );
30
}
31

32
export default function ProductHero(
33
 props: React.ComponentProps<typeof OverridenHero>
34
) {
35
 const context = useDynamicContent<ServerDynamicContentQuery>();
36
 return (
37
 <OverridenHero
38
 {...props}
39
 image={{ src: "noop", alt: "noop" }}
40
 title={
41
 context.data?.extraData?.customField ??
42
 "Add the Hero section title here"
43
 }
44
 />
45
 );
46
}
`
   * The `useDynamicContent` hook brings the data from the [@faststore/core](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview%23packagejson) package.
   * The `ServerDynamicContentQuery` specifies the type of data that we will get from the FastStore API package.
   * Since we are working with Hero, we import the Hero component and its styles.
   * The `useDynamicContent` hook holds the information in the `data` variable.
   * In return, we validate the data and display the image in the Hero and the product's name using some HTML elements.
5. Create an `index.tsx` file inside the components folder and paste the following code:
`1
import ProductHero from “./sections/ProductHero”
2

3
export default { ProductHero };
`

This file helps import and export our new component. Now that the component is ready, let’s create its section schema for the Headless CMS.

### 2\. Synchronizing the component with Headless CMS

To define a schema for the `ProductHero` component within the Headless CMS, follow the steps below:

1. Create the folders `cms/faststore` inside your project directory.
2. Inside `faststore`, create the `sections.json` file.
3. Paste the following code:
`1
[
2
 {
3
 "name": "ProductHero",
4
 "schema": {
5
 "title": "Hero with a Fixed Image",
6
 "description": "Add a quick promotion with an image/action pair",
7
 "type": "object",
8
 "required": ["title"],
9
 "properties": {
10
 "title": {
11
 "title": "Title",
12
 "type": "string"
13
 },
14
 "subtitle": {
15
 "title": "Subtitle",
16
 "type": "string"
17
 },
18
 "link": {
19
 "title": "Call to Action",
20
 "type": "object",
21
 "properties": {
22
 "text": {
23
 "type": "string",
24
 "title": "Text"
25
 },
26
 "url": {
27
 "type": "string",
28
 "title": "URL"
29
 },
30
 "linkTargetBlank": {
31
 "type": "boolean",
32
 "title": "Open link in new window?",
33
 "default": false
34
 }
35
 }
36
 },
37
 "colorVariant": {
38
 "type": "string",
39
 "title": "Color variant",
40
 "enumNames": ["Main", "Light", "Accent"],
41
 "enum": ["main", "light", "accent"]
42
 },
43
 "variant": {
44
 "type": "string",
45
 "title": "Variant",
46
 "enumNames": ["Primary", "Secondary"],
47
 "enum": ["primary", "secondary"]
48
 }
49
 }
50
 }
51
 }
52
]
`
4. Run `yarn cms-sync` to synchronize the changes.
5. Go to the VTEX Admin, and access **Storefront > Headless CMS**.
6. Click `Create document` and choose `Landing Page` to create a new landing page.
7. Add the new section.
8. Open the **Settings** tab, and in the SEO path, add the slug for the new landing page, for example, `my-landing-page`. This step is essential because this slug is being consumed in the `index.tsx` file from the `dynamicContent` folder and this slug identifies in the code which content we want to bring to the page.
9. Click `Save`.
10. Open your terminal and run `yarn dev`.
> Make sure you are logged in to your store account. If not run `vtex login {accountname}`.
11. Open the localhost indicated in the terminal and add the `/my-landing-page` to the slug, e.g., `https://localhots:3000/my-landing-page`.
12. Go to the localhost available and refresh the page. You will have the section similar to the following:

![{"base64":"  ","img":{"width":940,"height":660,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":27256,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/dynamic-content-new-section___82b343ceeef6504de8bdf7233f30d199.png"}}](https://read.calvincode.net/reader?url=https://vtexhelp.vtexassets.com/assets/docs/src/dynamic-content-new-section___82b343ceeef6504de8bdf7233f30d199.png)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/_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/headless-cms/dynamic-content/step-2-handling-the-dynamic-content-in-custom-sections.mdx)

[Step 1 - Setting up the store code for Dynamic Content« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content)[Developer tools and referencesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/developer-tools-overview)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/_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

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections%23before-you-begin)

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections%23instructions)

[1\. Creating the section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections%231-creating-the-section)[2\. Synchronizing the component with Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections%232-synchronizing-the-component-with-headless-cms)

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/headless-cms/dynamic-content/step-2-handling-the-dynamic-content-in-custom-sections.mdx)

Copy page

On this page

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections%23before-you-begin)

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections%23instructions)

[1\. Creating the section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections%231-creating-the-section)[2\. Synchronizing the component with Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections%232-synchronizing-the-component-with-headless-cms)

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 2 basic development setup in vtex 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-2-basic-development-setup-in-vtex-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-2-basic-development-setup-in-vtex-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-2-basic-development-setup-in-vtex-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-2-basic-development-setup-in-vtex-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-2-basic-development-setup-in-vtex-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-2-basic-development-setup-in-vtex-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-2-basic-development-setup-in-vtex-io/updates/release-notes)

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/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-2-basic-development-setup-in-vtex-io/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-2-basic-development-setup-in-vtex-io/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-2-basic-development-setup-in-vtex-io/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-getting-started)

[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)

[1\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io)

[2\. Creating the new app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-3-creating-the-new-app)

[3\. Declaring a theme block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-4-declaring-a-theme-block)

[4\. Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-5-defining-styles)

[5\. Structuring documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-6-structuring-documentation)

[6\. Consuming data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-7-consuming-data)

[7\. Translating the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-8-translating-the-component)

[8\. Improving performance with caching](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-9-improving-performance-with-caching)

[9\. Making your app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available)

[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-developing-custom-storefront-components)

[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)

[Master Data CRUD](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/create-master-data-crud-app)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/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-2-basic-development-setup-in-vtex-io/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-2-basic-development-setup-in-vtex-io/docs/guides/app-development-guides)

---

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

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/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-2-basic-development-setup-in-vtex-io/docs/guides/vtex-app-store)

---

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

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/api-reference)

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

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

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/troubleshooting)

---

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

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/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-2-basic-development-setup-in-vtex-io/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-2-basic-development-setup-in-vtex-io/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-2-basic-development-setup-in-vtex-io/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-getting-started)

[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)

[1\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io)

[2\. Creating the new app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-3-creating-the-new-app)

[3\. Declaring a theme block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-4-declaring-a-theme-block)

[4\. Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-5-defining-styles)

[5\. Structuring documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-6-structuring-documentation)

[6\. Consuming data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-7-consuming-data)

[7\. Translating the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-8-translating-the-component)

[8\. Improving performance with caching](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-9-improving-performance-with-caching)

[9\. Making your app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available)

[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-developing-custom-storefront-components)

[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)

[Master Data CRUD](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/create-master-data-crud-app)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/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-2-basic-development-setup-in-vtex-io/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-2-basic-development-setup-in-vtex-io/docs/guides/app-development-guides)

---

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

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/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-2-basic-development-setup-in-vtex-io/docs/guides/vtex-app-store)

---

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

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/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-2-basic-development-setup-in-vtex-io/docs/app-development)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-getting-started)

[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)

[1\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io)

Setting up your development environment

Learn how to set up your development environment to build storefront components with React and VTEX IO.

Any development on VTEX IO begins and ends with [**VTEX IO CLI**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference). VTEX IO CLI works as a communication gateway between your VTEX account and the VTEX IO development platform.

With VTEX IO CLI, you can log in to your VTEX account, manage workspaces, develop apps, and install new ones.

## Before you begin

* Make sure you are familiar with the core concepts of Store Framework, including blocks, store themes, and templates. If you need to refresh your knowledge or get acquainted with these concepts, you can refer to the getting started tutorial on [building storefronts with Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3).
* Check our recommended practices for tooling, features, flexibility, scalability, performance, accessibility, internationalization, and styling. For more information, please refer to [Best practices for developing custom storefront components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components).

## Instructions

### Step 1 - Getting started with VTEX IO CLI

1. [Install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install).
2. Once the installation is finished, open the terminal and log in to your VTEX account by running following command:

> Replace `{accountName}` with the name of your VTEX account.

`1

vtex login {accountName}

`

This will open a browser window prompting you to enter your credentials.

1. Enter your credential in the browser window and return to the terminal.
2. Run the `vtex whoami` command to show which `account` and `workspace` are being used by VTEX IO CLI.

![{"base64":"  ","img":{"width":3184,"height":1864,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":428247,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-2-basic-development-setup-in-vtex-io-0.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-2-basic-development-setup-in-vtex-io-0.png)

By logging in to your VTEX account with VTEX IO CLI, you will have access to various development tools and be able to manage your workspaces.

### Step 2 - Creating a workspace

To get started with development in VTEX IO, it is important to understand the concept of [workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/). Workspaces are isolated environments in which development occurs, and are similar to branches in a GitHub repository. This means that workspaces allow you to develop and test your changes without the risk of impacting live apps or conflicting with the work of other developers.

By default, when you first log in to VTEX IO, you are automatically placed in the in the `master` workspace, which represents the current live version of your store. Making changes in this workspace can potentially affect the user experience. To avoid this, you must create a separate [development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/) and switch to it before beginning any development work.

To switch to a development workspace, run the `vtex use` command in your terminal as shown below:

`1

vtex use {workspaceName}

`

> Replace `{workspaceName}` with the name of your development workspace.

This command will create a new workspace named `workspaceName` if it does not already exist and switch to it. If the workspace already exists, it will simply switch to it.

![{"base64":"  ","img":{"width":3184,"height":756,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":148140,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-2-basic-development-setup-in-vtex-io-1.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-2-basic-development-setup-in-vtex-io-1.png)

Once you have logged into your account and created your own development workspace, you are ready to start developing your React app. In the next step of this tutorial, you will learn how to start your app's project.

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-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/Getting-Started/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io/vtex-io-documentation-2-basic-development-setup-in-vtex-io.md)

[Storefront apps« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io//docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)[2\. Creating the new appNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io//docs/guides/vtex-io-documentation-3-creating-the-new-app)

See also

[VTEX IO CLIGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)[Creating a Development workspaceGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-creating-a-development-workspace)[WorkspaceApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-workspace)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-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

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io%23before-you-begin)

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io%23instructions)

[Step 1 - Getting started with VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io%23step-1-getting-started-with-vtex-io-cli)[Step 2 - Creating a workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io%23step-2-creating-a-workspace)

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/Getting-Started/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io/vtex-io-documentation-2-basic-development-setup-in-vtex-io.md)

Copy page

On this page

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io%23before-you-begin)

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io%23instructions)

[Step 1 - Getting started with VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io%23step-1-getting-started-with-vtex-io-cli)[Step 2 - Creating a workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io%23step-2-creating-a-workspace)

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