[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 updating edition apps 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-updating-edition-apps/docs/guides)

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

App Development

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

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/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-updating-edition-apps/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-updating-edition-apps/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

---

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

---

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

---

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

---

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

---

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

---

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

[Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-edition-app)

[Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-sponsor-account)

[Becoming a Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-becoming-a-sponsor-account)

[Developing an Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-configuring-an-edition-app)

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

[Seller Portal Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/seller-portal-edition-app)

---

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

---

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

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

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

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

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

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

---

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

App Development

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

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/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-updating-edition-apps/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-updating-edition-apps/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

---

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

---

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

---

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

---

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

---

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

---

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

[Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-edition-app)

[Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-sponsor-account)

[Becoming a Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-becoming-a-sponsor-account)

[Developing an Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-configuring-an-edition-app)

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

[Seller Portal Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/seller-portal-edition-app)

---

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

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

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

Updating Edition apps

Learn how to publish a new version of an Edition app.

This guide explains how to release a new version of an [Edition app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app) by defining new required apps for child accounts or by changing the Edition's initial settings.

## Before you begin

Before proceeding, ensure you are a [Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account) and have already [configured an Edition app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app).

## Instructions

1. Open your Edition app's folder and access the `apps.json` file using your preferred code editor.
2. Make the desired changes to the apps and settings in the file.
> Be aware that if you add an app to the Edition that is already installed on a child account, the app's installation type changes to `edition`. You can no longer remove it from the accounts or change its major version, as the Edition now enforces it. Similarly, if you remove an app from `apps.json`, VTEX will automatically uninstall it from all child accounts using this Edition. If you still need the removed app in some child accounts, you must reinstall it manually in each of those accounts.
3. Save and commit your changes.
4. [Publish and deploy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app) the new Edition version.

## Understanding the update process

After you publish the new version, VTEX automatically updates the Edition in all associated accounts. This process runs asynchronously, periodically, and individually for each child account.

> Note: VTEX only applies automatic updates for minor and patch version changes. If you release a new major version (a breaking change), you must update the Edition manually in each child account.

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/_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/managing-edition-apps/vtex-io-documentation-updating-edition-apps.md)

[Developing an Edition App« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps//docs/guides/vtex-io-documentation-configuring-an-edition-app)[Seller Portal Edition AppNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps//docs/guides/seller-portal-edition-app)

Contributors

1

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

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-updating-edition-apps%23before-you-begin)

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-updating-edition-apps%23instructions)

[Understanding the update process](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-updating-edition-apps%23understanding-the-update-process)

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/managing-edition-apps/vtex-io-documentation-updating-edition-apps.md)

Copy page

On this page

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-updating-edition-apps%23before-you-begin)

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-updating-edition-apps%23instructions)

[Understanding the update process](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-updating-edition-apps%23understanding-the-update-process)

On this page

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


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

[User] Provide a guide on guides vtex io documentation becoming a registered vtex app store developer 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-becoming-a-registered-vtex-app-store-developer/docs/guides)

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

App Development

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

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/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-becoming-a-registered-vtex-app-store-developer/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-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/app-development-guides)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/ab-tests)

---

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

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

[Developing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-developing-an-app)

[Setting your app's billing model](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-setting-your-apps-billing-model)

[Preparing your app for distribution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-preparing-your-app-distribution)

[Submitting your app to the VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store)

[Using the Docs builder to publish app documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/using-the-docs-builder-to-publish-app-documentation)

[App Store Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/managing-edition-apps)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/updates/release-notes)

App Development

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

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/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-becoming-a-registered-vtex-app-store-developer/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-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/app-development-guides)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/ab-tests)

---

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

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

[Developing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-developing-an-app)

[Setting your app's billing model](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-setting-your-apps-billing-model)

[Preparing your app for distribution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-preparing-your-app-distribution)

[Submitting your app to the VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store)

[Using the Docs builder to publish app documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/using-the-docs-builder-to-publish-app-documentation)

[App Store Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/managing-edition-apps)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/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-becoming-a-registered-vtex-app-store-developer/docs/app-development)

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

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

Becoming a registered VTEX App Store developer

[**VTEX App Store**](https://read.calvincode.net/reader?url=https://apps.vtex.com/) is a marketplace for VTEX IO plug-and-play solutions.

As a developer, you can share your own solutions with other VTEX users in the **VTEX App Store**, so they can also leverage them to grow their business.

To become a VTEX App Store seller, follow these steps:

1. Express interest to our team.
2. Sign a commercial agreement.
3. Register as a VTEX App Store seller.

## Instructions

### Step 1 - Expressing your interest

To publish your application or integration on the VTEX App Store, complete the [Application form](https://read.calvincode.net/reader?url=https://vtex.com/us-en/partners/).

This form helps our team understand the best approach and prioritize publication requests.

### Step 2 - Signing our commercial agreement

If the form is complete and the team agrees that the application is suitable for the VTEX App Store, the next step is to sign a commercial agreement with VTEX.

This contract, provided by the VTEX team, grants VTEX distribution rights over the app. Additionally, it enrolls your account in the VTEX [Partner Program](https://read.calvincode.net/reader?url=https://vtex.com/en-us/partners/) if you're not already a member.

> The Partner Program provides access to a VTEX account, allowing you to test and develop new apps and receive tech support from the VTEX partner team.

### Step 3 - Registering as a VTEX App Store seller

The App Store is a marketplace where developers who want to distribute their apps should register as sellers.

This [seller-marketplace configuration](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/configuring-the-marketplace-between-vtex-stores--tutorials%5F6520) is done through the `vtex.app-store-seller` app.

Follow the steps below to register as a new seller on the VTEX App Store:

1. In your terminal, log in to your VTEX account by running the `vtex login {accountName}` command. Replace the values between curly brackets with your account name.
2. Run `vtex install vtex.app-store-seller@0.x` to install the `vtex.app-store-seller` app.
3. Access the VTEX Admin of the account in which you're working.
4. In `Installed apps`, go to `Seller setup` and complete the required fields.
5. Select the sales channel you intend to use to connect to the App Store.
6. Choose an affiliate ID made up of three consonants:

![{"base64":"  ","img":{"width":2756,"height":1392,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":218487,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer-1.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer-1.png)

![{"base64":"  ","img":{"width":2762,"height":1388,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":211516,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer-2.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer-2.png)

After submitting your request to become a seller, you can track its status until it's approved by our team. This approval is required to publish your app successfully in the VTEX App Store.

Contributors

2

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

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/_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/vtex-app-store/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer.md)

[VTEX App Store« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer//docs/guides/vtex-app-store)[Developing an appNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer//docs/guides/vtex-io-documentation-developing-an-app)

See also

[Submitting your app to the VTEX App StoreApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store)

Contributors

2

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

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

ON THIS PAGE

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer%23instructions)

[Step 1 - Expressing your interest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer%23step-1-expressing-your-interest)[Step 2 - Signing our commercial agreement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer%23step-2-signing-our-commercial-agreement)[Step 3 - Registering as a VTEX App Store seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer%23step-3-registering-as-a-vtex-app-store-seller)

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/vtex-app-store/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer.md)

Copy page

On this page

ON THIS PAGE

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer%23instructions)

[Step 1 - Expressing your interest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer%23step-1-expressing-your-interest)[Step 2 - Signing our commercial agreement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer%23step-2-signing-our-commercial-agreement)[Step 3 - Registering as a VTEX App Store seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer%23step-3-registering-as-a-vtex-app-store-seller)

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

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

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

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

Guides

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

---

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

---

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

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

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

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

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

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

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

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

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

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

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

---

Integration Guides

---

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

---

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

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

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

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

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

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

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

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

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

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

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

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

---

Integration Guides

---

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

---

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

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

Promotions

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

The Promotions module is the place where the configuration of promotions and fees applied to your online store is carried out. Here, you can also create coupons to be associated to promotions. According to the configuration, a promotion can be scheduled, enabled or disabled and, after its creation, it can also be found through search or filter tools, and filed.

This overview article goes over what you can accomplish with the VTEX Promotions and Taxes module, including relevant links to our developer documentation about this topic.

## Understanding Promotions' module in VTEX

A [promotion](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/promocoes--6asfF1vFYiZgTQtOzwJchR) is a discount granted to the customer. It may be associated with one or more products, with shipping or with a trade policy. At VTEX, the retailer can create a number of rules that, depending on the context of the purchase, will define whether and how the discount will be applied.

In addition, there are six types of promotions:

* [Regular](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/promocoes--6asfF1vFYiZgTQtOzwJchR/7FjbeZdE2KMwk5L1t98pZI)
* [Buy Together](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/compre-junto--tutorials%5F323)
* [More For Less](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/leve-mais-por-menos--tutorials%5F325)
* [Progressive Discount](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/desconto-progressivo--tutorials%5F324)
* [Buy One Get One](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/compre-e-ganhe--tutorials%5F322)
* [Campaign Benefit](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/promocao-de-campanha--1ChYXhK2AQGuS6wAqS8Ume)

The [coupon](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/promocoes--6asfF1vFYiZgTQtOzwJchR/6RU676Ot6K15ZT1aJA8NRW) is a code entered in the cart by the customer. It grants a discount on the price of the purchase. To make a coupon available for use, you need to associate the coupon to a Promotion. To be valid, the coupon has to be associated with a promotion, and a single coupon can be associated with one or more promotions. But there’s a quantity limit to the active coupons.

[Campaign audience](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/audiencias-de-campanhas--3o7lhpNseXY2WmjZO0gQ6m) is a feature that allows you to define the target audience for promotions, the feature consists of creating criteria for segmenting customers. You can only apply a campaign audience if it is associated with one or more campaign promotions.

Using the Promotions API allows you to manage and retrieve all promotions, coupons and campaign audience from your VTEX store.

Retrieving promotions' information

A VTEX store can have different types of promotions for different kinds of trade policy. To retrieve information about your VTEX store promotions, access the available API.

* [Get All Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getallbenefits)
[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getallbenefits)
* [](https://developers.vtex.com/vtex-rest-api/reference/getallbenefits)[Get Promotion or Tax By ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getcalculatorconfigurationbyid)
[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getcalculatorconfigurationbyid)
* [](https://developers.vtex.com/vtex-rest-api/reference/getcalculatorconfigurationbyid)[List archived Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getarchivedpromotions)
[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getarchivedpromotions)

### Managing your promotions

There are several actions a VTEX store can perform on promotions. In the next sections, you will find the main actions related to a store’s promotion management routine.

Creating promotions or taxes

VTEX offers different types of promotions, you can create a promotion or tax, create multiple promotions by SKU and change the settings and data of any promotion using the APIs.

* [Create or Update Promotion or Tax](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/createorupdatecalculatorconfiguration)

Updating promotions with multiple SKUs

To update information from a Multiple SKU Promotion.

* [Update Multiple SKU Promotion](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/put%5Fapi-rnb-pvt-import-calculatorconfiguration-promotionid)

Archiving/Unarchiving promotions or taxes

If you no longer want a promotion to be used, you can move it to the list of archived promotions or unarchiving if you want to use it. You cannot delete a promotion, only archive it.

* [Archive Promotion or Tax](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/archivepromotion-1)
[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/archivepromotion-1)
* [](https://developers.vtex.com/vtex-rest-api/reference/archivepromotion-1)[Archive Promotion or Tax](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/archivepromotion-1)
[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/archivepromotion-1)

### Coupons

Coupons cannot be deleted, only archived. It is important to emphasize that you can only archive one coupon at a time. You can edit and reuse a coupon, but the coupon code can not be modified.

There is a limited quantity of active coupons. Coupon reuse is highly recommended since a high number of coupons may compromise the Promotions & Taxes performance.

If you try to create a coupon with an existing coupon code, the API will update the existing coupon.

Getting coupons

You can create one coupon or multiple coupons at a time.

* [Create coupon](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/post%5Fapi-rnb-pvt-coupon)
* [Create multiple coupons](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/post%5Fapi-rnb-pvt-multiple-coupons)
* [Coupon Massive Generation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/massivegeneration)

Retrieving coupon information

You perform different actions to retrieve coupon information.

* [Get coupon by coupon code](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getbycouponcode)
* [Get archived coupon by coupon code](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getarchivedbycouponcode)
* [Get coupon usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getusage)
* [Get all coupons](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getusage)

Archiving/Unarchiving coupons

You cannot delete coupons, only archive or unarchive them.

* [Archive coupon by coupon code](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/archivebycouponcode)
* [Unarchive coupon by coupon code](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/unarchivebycouponcode)

Updating coupons

Coupons can be updated as you wish.

* [Update coupon](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/update)
[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/update)

### Campaign Audiences

To activate the newly created campaign audience, you must associate it to a [Campaign promotion](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/campaign-promotion--1ChYXhK2AQGuS6wAqS8Ume).

Creating campaign audiences

You can create campaign audiences to segment your store's promotions based on defining target audiences meeting specific criteria.

* [Create campaign audience](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/setcampaignconfiguration)

Retrieving campaign audience information

You can retrieve campaign audience information using the following APIs.

* [Get campaign audience configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getcampaignconfiguration)
* [Get all campaign audiences](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getcampaignaudiences)

### Policy Engine

The Policy Engine API creates [promotion alarms](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/using-policy-engine-api-on-promotion-alerts) when selling products with undesired prices and promotions. It will create conditions that will check if the prices and the promotions are correct.

If not, the system will alert the store by email with information about the product sold at unexpected prices.

Creating a promotion alert

To create a new promotion alert, you should use this API.

* [Create Policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/policy%5Fcreateorupdate)

Retrieving policy engine information

You can retrieve policy engine information using the following APIs.

* [Get Policy by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/policies-system-api/%23get-/api/policy-engine/policies/-id-)
* [Get Policy List](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/policy%5Flist)

Evaluating policies

Consult and verify all policies that meet the conditions in the request body.

* [Evaluate Policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/policy%5Fevaluate)

Updating an existing policy

To update an existing promotion alert, you should use this API.

* [Update Policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/put%5Fapi-policy-engine-policies-id)

Deleting a policy

To delete an existing promotion alert, you should use this API.

* [Delete Policy by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/policy%5Fdelete)

## Surcharges

A [surcharge](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/promocoes--6asfF1vFYiZgTQtOzwJchR/3DcO1XrLqlbZsq80zxSgZS) is the opposite of a promotion, that is, it is an additional percentage added to the product price in order to increase the value. A surcharge can be configured on the basis of a range of conditions, such as postal code (CEP) range, department, the brand of the products, the customer cluster, and so on. The surcharge is added only in the shopping cart, in the area marked Tax.

The surcharge is applied in accordance with the registration done on the seller. So if your store’s shopping cart has another seller’s product, the surcharge to be applied to that product will be the one registered on the admin of the seller that owns the product. Surcharges registered in the [Pricing module](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/pricing-overview) will not be taken into account, even if this surcharge is associated with this product.

Retrieving Surcharges/Taxes information

To retrieve information about your VTEX store taxes, access the available API

* [Get All Taxes](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getalltaxes)
[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getalltaxes)
* [](https://developers.vtex.com/vtex-rest-api/reference/getalltaxes)[List Archived Taxes](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getarchivedtaxes)
[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getarchivedtaxes)

[Contributors](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getarchivedtaxes)

[2](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getarchivedtaxes)

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

[Pricing« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview//docs/guides/pricing-overview)[SubscriptionsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview//docs/guides/subscriptions)

Contributors

2

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

[Understanding Promotions' module in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview%23understanding-promotions-module-in-vtex)

[Managing your promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview%23managing-your-promotions)[Coupons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview%23coupons)[Campaign Audiences](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview%23campaign-audiences)[Policy Engine](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview%23policy-engine)

[Surcharges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview%23surcharges)

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/promotions-overview.md)

Copy page

On this page

ON THIS PAGE

[Understanding Promotions' module in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview%23understanding-promotions-module-in-vtex)

[Managing your promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview%23managing-your-promotions)[Coupons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview%23coupons)[Campaign Audiences](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview%23campaign-audiences)[Policy Engine](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview%23policy-engine)

[Surcharges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview%23surcharges)

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 access control list 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/access-control-list/docs/guides)

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

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

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

[How search parameters work](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/how-search-parameters-work)

[Search Control – fulltextSearchBox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/search-control-fulltextsearchbox)

[Consult store search terms information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/consult-store-search-terms-information)

[Consult product search information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/consult-product-search-information)

[Get banner list for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/get-banner-list-for-a-specific-search)

[Get a list of the possible facets for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search)

[Segmenting the search result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/vtex-io-documentation-segmenting-the-search-result)

[Access Control List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/access-control-list)

[Delivery promise for headless stores (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/delivery-promise-for-headless-stores)

---

Storefront Permissions

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

[How search parameters work](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/how-search-parameters-work)

[Search Control – fulltextSearchBox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/search-control-fulltextsearchbox)

[Consult store search terms information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/consult-store-search-terms-information)

[Consult product search information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/consult-product-search-information)

[Get banner list for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/get-banner-list-for-a-specific-search)

[Get a list of the possible facets for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search)

[Segmenting the search result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/vtex-io-documentation-segmenting-the-search-result)

[Access Control List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/access-control-list)

[Delivery promise for headless stores (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/delivery-promise-for-headless-stores)

---

Storefront Permissions

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

Search

[Access Control List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/access-control-list)

Access Control List

By default, all VTEX stores are configured to display all available products during every navigation session. The Access Control List feature allows you to create a list of users that can or cannot access specific products in the store.

## Creating a specification

To configure the Access Control List, you must first create one of the following product specifications either through [Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications) or on [VTEX Admin](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/adding-specifications-or-product-fields--tutorials%5F106) and set their values, which represent groups of customers that can be set on Master Data. All values for both specifications must be separated by `;` (i.e.: `1;2;3`).

| Specification name | Example values | Description                                                                     |
| ------------------ | -------------- | ------------------------------------------------------------------------------- |
| \_blocklist        | 1;2;3          | Blocklist: Restricts product visibility based on the defined navigation values. |
| \_allowlist        | 1;2;3          | Allowlist: Enables product visibility based on the defined navigation values.   |

> Do not set both specifications at the same time for the same product, otherwise the product will not be displayed in any scenario. Read [Behavior](#behavior) for more information.

After creating the product specification, Intelligent Search automatically triggers a reindexing process to update the values in the search database.

## Defining segmented navigation

To define segmented navigation, you must configure the `accesscontrollist` facet on the [vtex-segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result) app. For example, `acesscontrollist:1` can define navigation for a customer, where a certain product will not be displayed in the search results.

`1

query {

2

 productSearch(

3

 selectedFacets: [

4

 {key: "trade-policy", value: "1"},

5

 {key: "accesscontrollist", value: "1"}

6

 ]

7

 )

8

 {

9

 products {

10

 productId,

11

 productName

12

 }

13

 }

14

}

`

### Behavior

Wherever the `accesscontrollist` facet is present, `_blocklist` and `_allowlist` can be applied to each product and result in one of the following scenarios:

| \_blocklist                              | \_allowlist                              | Result                                                                                |
| ---------------------------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------- |
| Empty value or nonexistent specification | Empty value or nonexistent specification | The product will always be visible.                                                         |
| Defined value                            | Empty value or nonexistent specification | The product will be visible unless the accesscontrollist value is included in \_blocklist.  |
| Empty value or nonexistent specification | Defined value                            | The product will be visible only if the accesscontrollist value is included in \_allowlist. |
| Defined value                            | Defined value                            | The product will not be visible to anyone. This is an invalid scenario.                     |

Contributors

1

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

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/Search/access-control-list.md)

[Segmenting the search result« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list//docs/guides/vtex-io-documentation-segmenting-the-search-result)[Delivery promise for headless stores (Beta)Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list//docs/guides/delivery-promise-for-headless-stores)

Contributors

1

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

ON THIS PAGE

[Creating a specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/access-control-list%23creating-a-specification)

[Defining segmented navigation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/access-control-list%23defining-segmented-navigation)

[Behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/access-control-list%23behavior)

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/Search/access-control-list.md)

Copy page

On this page

ON THIS PAGE

[Creating a specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/access-control-list%23creating-a-specification)

[Defining segmented navigation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/access-control-list%23defining-segmented-navigation)

[Behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/access-control-list%23behavior)

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