[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 workspace behavior with app installations 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-workspace-behavior-with-app-installations/docs/guides)

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

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/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-workspace-behavior-with-app-installations/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-workspace-behavior-with-app-installations/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-workspace-behavior-with-app-installations/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-getting-started)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/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-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-workspace)

[Creating a Development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-creating-a-development-workspace)

[Creating a Development workspace for a Legacy CMS store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy)

[Creating a Production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-creating-a-production-workspace)

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

[Best practices on workspaces management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-workspaces-best-practices)

---

Managing apps

---

Development guides

---

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

---

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

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/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-workspace-behavior-with-app-installations/docs/guides/vtex-app-store)

---

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

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/api-reference)

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

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/troubleshooting)

---

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

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/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-workspace-behavior-with-app-installations/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-workspace-behavior-with-app-installations/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-workspace-behavior-with-app-installations/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-getting-started)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/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-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-workspace)

[Creating a Development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-creating-a-development-workspace)

[Creating a Development workspace for a Legacy CMS store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy)

[Creating a Production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-creating-a-production-workspace)

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

[Best practices on workspaces management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-workspaces-best-practices)

---

Managing apps

---

Development guides

---

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

---

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

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/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-workspace-behavior-with-app-installations/docs/guides/vtex-app-store)

---

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

---

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

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

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

Workspace behavior with app installations

On VTEX IO, [workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace) function similarly to [Git branches](https://read.calvincode.net/reader?url=https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell) with automatic [rebase](https://read.calvincode.net/reader?url=https://git-scm.com/book/en/v2/Git-Branching-Rebasing). Your work in development and production workspaces is always based on what's in the master workspace.

Below is an example to illustrate the behavior of apps when performing operations on workspaces.

Imagine there is a VTEX account with four identical workspaces:

* `master`: `appA@1.x`
* `prod1`: `appA@1.x`
* `prod2`: `appA@1.x`
* `dev1`: `appA@1.x`

The following sections present scenarios based on this example. Check what happens when you:

* [Install an app on development or production](#install-an-app-on-development-or-production)
* [Install an app on master](#install-an-app-on-master)
* [Promote a workspace](#promote-a-workspace)

## Install an app on development or production

[Installing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) on a development or production workspace does not affect other workspaces.

Considering the given example, imagine the following actions:

* Installing `appA@2.x` on `prod1`
* Installing `appC@2.x` on `prod2`
* Installing `appC@3.x` on `dev1`

This would be the result:

* `master`: `appA@1.x`
* `prod1`: `appA@2.x`
* `prod2`:`appA@1.x`, `appC@2.x`
* `dev1`: `appA@1.x`, `appC@3.x`

## Install an app on master

When you install an app on the master workspace, it is installed on every workspace that does not have this app installed. If a workspace has the same app installed with another major version, the app version on this workspace is unchanged.

Considering the given example, imagine the following action:

* Installing `appB@0.x` on `master`

This would be the result:

* `master`: `appA@1.x`, `appB@0.x`
* `prod1`: `appA@2.x`, `appB@0.x`
* `prod2`:`appA@1.x`, `appB@0.x`, `appC@2.x`
* `dev1`: `appA@1.x`, `appB@0.x`, `appC@3.x`

## Promote a workspace

When a production workspace is [promoted to master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master), all the other workspaces are updated to reflect the changes seen in the promoted workspace.

Considering the given example, after promoting `prod2` to `master`, this is the result:

* `master`: `appA@1.x`, `appB@0.x`, `appC@2.x`
* `prod1`: `appA@2.x`, `appB@0.x`, `appC@2.x`
* `dev1`: `appA@1.x`, `appB@0.x`, `appC@3.x`

> After promoting a workspace, the name of the promoted workspace will not appear in the [list of workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-command-reference%23workspace-list), since it became the new master workspace.

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/_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/App-Guides/configuring-workspaces/vtex-io-documentation-workspace-behavior-with-app-installations.md)

[Creating a Production workspace« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations//docs/guides/vtex-io-documentation-creating-a-production-workspace)[Best practices on workspaces managementNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations//docs/guides/vtex-io-documentation-workspaces-best-practices)

Contributors

1

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

ON THIS PAGE

[Install an app on development or production](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations%23install-an-app-on-development-or-production)

[Install an app on master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations%23install-an-app-on-master)

[Promote a workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations%23promote-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/App-Guides/configuring-workspaces/vtex-io-documentation-workspace-behavior-with-app-installations.md)

Copy page

On this page

ON THIS PAGE

[Install an app on development or production](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations%23install-an-app-on-development-or-production)

[Install an app on master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations%23install-an-app-on-master)

[Promote a workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations%23promote-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=)


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

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

Guides

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

---

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

---

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

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

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

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

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

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

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

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

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

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

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

---

Integration Guides

---

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

---

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

---

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

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-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-overview/docs/guides/data-protection-plus)

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

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

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

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

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

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

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

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

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

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

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

---

Integration Guides

---

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

---

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

---

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

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-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-overview/docs/guides/data-protection-plus)

---

Weni by VTEX

---

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

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

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

Checkout

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

## Customizing the Checkout UI

All VTEX stores have a native Checkout UI ready to be used from the start of their operations on the platform. However, if the merchant wants to change some features on this UI, VTEX offers the option of customizing the Checkout. See the links below for helpful information and apps to customize the Checkout UI of your store.

* [Checkout customization guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/checkout-customization-guide)
* [Checkout UI Custom app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-custom-v0)
* [Checkout UI Settings app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-settings)
* [Checkout Settings (B2B)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings)
* [Customizing the Header and Footer blocks by page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page)
* [Customizing checkout confirmation pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/customize-checkout-confirmation-pages)
* [Enabling an Observation field on the Checkout page](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/enable-an-observation-field-on-the-checkout-page)
* [Layout Development Guide for payment methods in Smart Checkout VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/layout-development-guide-for-payment-methods-in-smart-checkout-vtex)
* [How to set up and use checkout data from the customer side (vtex.js for Checkout)](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/vtexjs-for-checkout)
* [Changing payment methods on Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/change-payment-method-names-in-checkout)

Smart Checkout - Payment layout customization example:

![{"base64":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAQAAAADCAIAAAA7ljmRAAAACXBIWXMAAAPoAAAD6AG1e1JrAAAAMklEQVR4nAEnANj/AKOkpMDIyrm9wMXHxwClqaoEEhZ3gofz8vMA4ODglI+Kqqqkm6eby+IXZdfAflkAAAAASUVORK5CYII=","img":{"src":"https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/Checkout/Layout_Dev_Guide_29.gif","width":512,"height":421,"type":"gif"}}](https://read.calvincode.net/reader?url=https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/Checkout/Layout_Dev_Guide_29.gif)

## Understanding Checkout data structures

In the VTEX Checkout architecture, the main data structure is the `orderForm` object. This object has several sections and fields that allow you to control all the important information about the order. See the links below for helpful information and endpoints related to the `orderForm` object.

* [OrderForm overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields)
* [Setting discounts using the Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/set-a-discount-using-the-checkout-api)
* [Enabling orderForm optimization - Store Framework only](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization)
* [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)
* [POST - Clear orderForm messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/clearorderformmessages)

## Collecting custom customer information

To request additional customer information besides what the `orderForm` collects, stores can create `custom fields`. See the links below for helpful information and endpoints related to custom customer information.

* [Adding and handling custom information in the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order)
* [Custom fields created by the Mercado Libre connector](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/get-payment-data-mercado-libre-orders-api%23understanding-customdata)
* [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)

> This module may process personal or sensitive information. Learn more about how VTEX handles data privacy at our [Data privacy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-privacy) guide.

## Accessing customer information

Once you have the customer information, you can check their profile information or even add them to a specific cart. See the links below to access endpoints related to customer information.

* [Enable the Save user information opt-in](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/enable-the-save-user-data-opt-in)
* [GET - Get customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getclientprofilebyemail)
* [POST - Add customer profile](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addclientprofile)
* [POST - Add customer preferences](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addclientpreferences)
* [POST - Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addshippingaddress)

## Accessing seller information

In a marketplace, you can check the seller database to find out which sellers are available in a given region and configure the exchange of sellers that fulfill an order. See the links below to access endpoints related to seller information.

* [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-)
* [GET - Get the seller change window](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getwindowtochangeseller)
* [POST - Update the seller change window](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/updatewindowtochangeseller)

## Handling the shopping cart

In your store, you can perform many actions related to the shopping cart, including adding security items, simulating carts, changing the number of items, among others. See the links below for helpful information and endpoints related to handling the store shopping cart.

* [Minicart - Configuration and customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart)
* [ADD TO CART button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button%23configuration)
* [reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/recaptcha)
* [Implementing reCAPTCHA in integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/implementing-recaptcha-in-integrations)
* [Enabling Manual Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/enable-the-manual-price)
* [Checking marketing UTMs used at Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/check-marketing-utms-used-at-checkout)
* [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)
* [PATCH - Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/itemsupdate)
* [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 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 coupons to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addcoupons)
 Minicart view:
![{"base64":"  ","img":{"width":2880,"height":1575,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":1703446,"url":"https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/Checkout/Minicart_Dev_Guide_1.gif"}}](https://read.calvincode.net/reader?url=https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/Checkout/Minicart_Dev_Guide_1.gif)

 reCAPTCHA view:

![{"base64":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAQAAAABCAIAAAB2XpiaAAAACXBIWXMAAAPoAAAD6AG1e1JrAAAAFUlEQVR4nGPYt29fV2fnr1+/GZi4ATQlBtOH1lmdAAAAAElFTkSuQmCC","img":{"src":"https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/Checkout/reCAPTCHA_Dev_Guide_1.gif","width":616,"height":164,"type":"gif"}}](https://read.calvincode.net/reader?url=https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/Checkout/reCAPTCHA_Dev_Guide_1.gif)

## Getting information and simulating shipping logistics

By verifying addresses, pickup points, and fulfillment simulations, you can have an overview of how the shipping process will be carried out in your store. Additionally, you can configure your store to allow shipping to other countries. See the links below to access endpoints related to shipping.

* [Calculating SLA](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/calculatesla)
* [Configuring Global Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/configure-the-global-checkout)
* [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)
* [POST - Fulfillment simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/fulfillment-simulation%23request-body-example---checkout-simulation)

## Creating orders via API

APIs allow you to simulate all the order steps a customer goes through. See the links below for helpful information and endpoints related to the order flow.

* [Creating a regular order using the Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/create-a-regular-order-using-the-checkout-api)
* [Creating a regular order from an existing cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart)
* [PUT - Place an order (no cart information available)](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/placeorder)
* [POST - Place an order from an existing cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/placeorderfromexistingorderform)
* [POST - Process order](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/processorder)

## Configuring tax customization systems

When your store sells products in several regions or has inventories in different locations, you may need to calculate different taxes for each order. To facilitate this, VTEX allows you to integrate an external tax calculation provider. See the links below to access information on how to integrate an external tax calculation provider with your store.

* [Tax service - Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/tax-services-overview)
* [Tax service - Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/tax-services-specification%23checkout-configuration)
* [Tax service - Recipe](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/tax-services-recipe)
* [Tax service - Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/tax-services-reference-implementation)

## Integrating Checkout with apps

On VTEX checkout, some features are activated through apps. See the links below for information about available apps for your store checkout.

* [Setting up Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23creating-variables)
* [Migrating Google Tag Manager app from major 2.x to major 3.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app%23before-you-start)
* [Hotjar App - Website Heatmaps & Behavior Analytics Tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-hotjar)
* [PowerReviews App - UGC (User Generated Content) Ratings & Reviews Tool](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews)
 Hotjar heatmap example:

![{"base64":"  ","img":{"width":952,"height":646,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":534036,"url":"https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/Checkout/Hotjar_example_Dev_Guide_1.png"}}](https://read.calvincode.net/reader?url=https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/Checkout/Hotjar_example_Dev_Guide_1.png)

Product review example:

![{"base64":"  ","img":{"width":1009,"height":1024,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":371724,"url":"https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/Checkout/Product_review_example_Dev_Guide_1.png"}}](https://read.calvincode.net/reader?url=https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/Checkout/Product_review_example_Dev_Guide_1.png)

Contributors

5

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

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

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

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

Was this helpful?

Yes

No

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

[Orders« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview//docs/guides/orders-overview)[PaymentsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview//docs/guides/payments-overview)

See also

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

Contributors

5

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

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

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

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

ON THIS PAGE

[Customizing the Checkout UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23customizing-the-checkout-ui)

[Understanding Checkout data structures](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23understanding-checkout-data-structures)

[Collecting custom customer information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23collecting-custom-customer-information)

[Accessing customer information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23accessing-customer-information)

[Accessing seller information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23accessing-seller-information)

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

[Getting information and simulating shipping logistics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23getting-information-and-simulating-shipping-logistics)

[Creating orders via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23creating-orders-via-api)

[Configuring tax customization systems](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23configuring-tax-customization-systems)

[Integrating Checkout with apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23integrating-checkout-with-apps)

Was this helpful?

 Send feedback

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

Copy page

On this page

ON THIS PAGE

[Customizing the Checkout UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23customizing-the-checkout-ui)

[Understanding Checkout data structures](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23understanding-checkout-data-structures)

[Collecting custom customer information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23collecting-custom-customer-information)

[Accessing customer information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23accessing-customer-information)

[Accessing seller information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23accessing-seller-information)

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

[Getting information and simulating shipping logistics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23getting-information-and-simulating-shipping-logistics)

[Creating orders via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23creating-orders-via-api)

[Configuring tax customization systems](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23configuring-tax-customization-systems)

[Integrating Checkout with apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23integrating-checkout-with-apps)

On this page

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


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

[User] How do I use the VTEX store components productdescription app? Provide documentation and configuration details.

[Assistant]
Documentation

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

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

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

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

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

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

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

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

VTEX IO Apps

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

---

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

[Autocomplete Result List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/autocompleteresults)

[Availability Subscriber](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/availabilitysubscriber)

[Back To Top Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/backtotopbutton)

[Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/image)

[Info Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/infocard)

[Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/logo)

[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/notification)

[Product Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productbrand)

[Product Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productdescription)

[Product Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productimages)

[Product Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productname)

[Product SKU Attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productskuattributes)

[Search Bar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/searchbar)

[Share](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/share)

[Shipping Simulator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/shippingsimulator)

[SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/skuselector)

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

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

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

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

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

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

---

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

VTEX IO Apps

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

---

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

[Autocomplete Result List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/autocompleteresults)

[Availability Subscriber](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/availabilitysubscriber)

[Back To Top Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/backtotopbutton)

[Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/image)

[Info Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/infocard)

[Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/logo)

[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/notification)

[Product Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productbrand)

[Product Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productdescription)

[Product Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productimages)

[Product Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productname)

[Product SKU Attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productskuattributes)

[Search Bar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/searchbar)

[Share](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/share)

[Shipping Simulator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/shippingsimulator)

[SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/skuselector)

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

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

Product Description

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

Version: 3.178.5

Latest version: 3.178.5

The `product-description` block displays the description of a product. This Component can be imported and used by any VTEX App.

![{"base64":"  ","img":{"width":1839,"height":691,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":122179,"url":"https://user-images.githubusercontent.com/67270558/147771999-64d529ab-ef49-4cb3-a592-8f54bcbbeac2.png"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/67270558/147771999-64d529ab-ef49-4cb3-a592-8f54bcbbeac2.png)

## Configuration

1. Import the `vtex.store-components` app to your theme's dependencies in the `manifest.json` file as in the following example:

`1

 "dependencies": {

2

 "vtex.store-components": "2.x"

3

 }

`

1. Add the `product-description` block to any child of the `store.product` template (Product Details Page template). For example:

`1

 "store.product": {

2

 "children": [

3

 "flex-layout.row#product",

4

 ]

5

 },

6

 "flex-layout.row#product": {

7

 "children": [

8

+ "product-description"

9

 ]

10

 }

`

1. Then, declare the `product-description` block using the props stated in the [Props](#props) table.

### Props

| Prop name       | Type             | Description                                                                                | Default   |
| --------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------- |
| classes         | CustomCSSClasses | Overrides default CSS handles. To better understand how this prop works, check [this document](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/css-handles%23usecustomclasses). Note that this is only helpful if you're using this block as a React component. | undefined |
| collapseContent | Boolean          | If true, whenever the product description is too big, it will collapse and show a "Show More" button. When false, it will never collapse and will always show the whole description.                                                       | true      |
| showTitle       | boolean          | Define whether or not to show the title.                                                                                | true      |
| title           | string           | Defines a custom title for the description section.                                                                                | undefined |

## Customization

To apply CSS customizations in this and other blocks, follow the [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization) guide.

| CSS Handles                 |
| --------------------------- |
| productDescriptionContainer |
| productDescriptionText      |
| productDescriptionTitle     |

[Product Brand« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productbrand)[Product ImagesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productimages)

See also

[Vtex.store ComponentsVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)

ON THIS PAGE

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

[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productdescription%23props)

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

Was this helpful?

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


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

[User] Provide a guide on guides categories 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/categories/docs/guides)

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

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

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

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

[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/brands)

[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/products)

[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/specifications)

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

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

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

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

[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/images)

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

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

---

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

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

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

[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/brands)

[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/products)

[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/specifications)

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

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

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

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

[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/images)

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

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

---

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

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

Categories

Categories organize your product assortment within your ecommerce. They work as hierarchical levels of product classification, making your client’s search for a product easier and keeping your store organized.

## Category tree

The category tree is the backbone of the Catalog, so it needs to be carefully planned and validated before importing to VTEX.

We strongly recommend starting to work on the category tree by creating a table similar to this one:

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

The idea behind this template is to allow easy visualization of how the tree is organized and how the specifications are being presented.

VTEX does not limit the number of categories that can be created. We strongly recommend having a maximum of three levels of categories.

## Limitations

* **Moving categories**: Although it is possible to move categories to different levels (higher/lower) and/or different departments, this is too risky because of the specifications attached to this category. This action can negatively affect product information, because products can inherit not only the previous specifications but also the new ones. To avoid issues, we recommend following the workaround described in [Deactivating and reorganizing categories](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/deactivating-and-reorganizing-categories--tutorials%5F264%23changing-the-category-tree).
* **Deleting categories**: You cannot delete a category unless you make a [full cleanup](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/database-maintenance-full-cleanup--34P9LGs7BCIQK6acQom802) of the catalog. This means you cannot delete categories unless you clear the entire catalog.

## Category inheritance

All specifications registered in the upper levels of the hierarchy are inherited by the lower categories. In the example above, we have what we call the root category "level zero". This means that all specs registered at this level (Gender, Simple Color, and Country) will be inherited by level 1.

Note that the Shirt category (level 2) has the `Style` field as a specification. This means that the product contained in this category will have as attributes the `Style` field and all others defined in the upper level, in this case, the root level.

Products must be associated with the categories at the lowest level of the category tree. In this example, they must be associated with the category: `Jeans` with `Pants` or `Polo` with `Shirt`.

## Create a category

Creating a category is the most basic configuration you must do in Catalog. For a product to exist, it must have a category associated with it.

To create a category, one can use the [Create category](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-post-category) endpoint. See the request body example below of the creation of a category called Clothing:

**Request body**

`1

{

2

 "Name": "Clothing",

3

 "FatherCategoryId": null,

4

 "Title": "Clothing",

5

 "Description": "Shop from brands like Patagonia, The North Face, Billabong, Columbia, and more to dress yourself for success.",

6

 "Keywords": "Clothing,apparel,clothes, clothing department",

7

 "IsActive": true,

8

 "ShowInStoreFront": true,

9

 "ShowBrandFilter": true,

10

 "ActiveStoreFrontLink": true,

11

 "GlobalCategoryId": 772,

12

 "StockKeepingUnitSelectionMode": "SPECIFICATION",

13

 "Score": null

14

}

`

**Response body**

`1

{

2

 "Id": 2000089,

3

 "Name": "Clothing",

4

 "FatherCategoryId": null,

5

 "Title": null,

6

 "Description": "Shop from brands like Patagonia, The North Face, Billabong, Columbia, and more to dress yourself for success.",

7

 "Keywords": "Clothing,apparel,clothes, clothing department",

8

 "IsActive": true,

9

 "ShowInStoreFront": true,

10

 "ShowBrandFilter": true,

11

 "ActiveStoreFrontLink": true,

12

 "GlobalCategoryId": 772,

13

 "StockKeepingUnitSelectionMode": "SPECIFICATION",

14

 "Score": null,

15

 "LinkId": null,

16

 "HasChildren": false

17

}

`

In this example, the created category is a parent category, which means that it is not inside another category. A _parent category_ can have subcategories, or _children categories_, associated with it. To create a subcategory, you must insert the parent category ID on the `"FatherCategoryId"`.

> Do not forget to activate the categories, otherwise the products will not be indexed and thereafter will not be displayed on the website.

## Edit a category

You can edit an existing category by using the [Update Category](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-put-category) endpoint.

## Get category tree

You can get information of all the category tree or just some specific level by using the [Get Category Tree](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-category-tree) endpoint.

## Get a category

You can get information about a specific category by using the [Get Category by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-category)endpoint.

## FAQ

See below the answer to some frequently asked questions.

### When should I choose to import categories manually or by an integration via API?

It is not common for the customer to change the category tree once it is defined. Usually, specific changes may be required and can be made manually under VTEX Admin rather than having one more integration to take care of. Potentially we can find some cases where the category tree is built progressively according to the evolution of the store. But this typically happens during the validation of a new business. In that case, having category integration can be useful.

### What category fields are actually used by VTEX Intelligent Search?

* Title
* Description

### What are the best practices for Title and Meta Tag Description for SEO?

* The Title should be about 55 to 60 characters long.
* When writing the Meta Tag Description, aim for about 1-2 sentences (140-160 characters) long. Offer a compelling reason to visit the webpage. Add a clear call to action, address an emotional pain point, or offer a specific benefit to visitors.

> Department, Category, and Subcategory titles can be customized using VTEX Intelligent Search. So on the search navigation bar, the store can present different titles for each category level.

Contributors

3

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

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

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

Was this helpful?

Yes

No

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

[Catalog« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories//docs/guides/catalog-integration)[BrandsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories//docs/guides/brands)

Contributors

3

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

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

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

ON THIS PAGE

[Category tree](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23category-tree)

[Limitations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23limitations)

[Category inheritance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23category-inheritance)

[Create a category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23create-a-category)

[Edit a category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23edit-a-category)

[Get category tree](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23get-category-tree)

[Get a category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23get-a-category)

[FAQ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23faq)

[When should I choose to import categories manually or by an integration via API?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23when-should-i-choose-to-import-categories-manually-or-by-an-integration-via-api)[What category fields are actually used by VTEX Intelligent Search?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23what-category-fields-are-actually-used-by-vtex-intelligent-search)[What are the best practices for Title and Meta Tag Description for SEO?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23what-are-the-best-practices-for-title-and-meta-tag-description-for-seo)

Was this helpful?

 Send feedback

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

Copy page

On this page

ON THIS PAGE

[Category tree](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23category-tree)

[Limitations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23limitations)

[Category inheritance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23category-inheritance)

[Create a category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23create-a-category)

[Edit a category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23edit-a-category)

[Get category tree](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23get-category-tree)

[Get a category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23get-a-category)

[FAQ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23faq)

[When should I choose to import categories manually or by an integration via API?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23when-should-i-choose-to-import-categories-manually-or-by-an-integration-via-api)[What category fields are actually used by VTEX Intelligent Search?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23what-category-fields-are-actually-used-by-vtex-intelligent-search)[What are the best practices for Title and Meta Tag Description for SEO?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23what-are-the-best-practices-for-title-and-meta-tag-description-for-seo)

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