VTEX Developer Portal

Edition App

An Edition App consists of a bundle of settings, policies, back-end and front-end apps encapsulated and exported by a Sponsor Account.

Its main objective is to facilitate the installation of numerous apps that might be considered as essential to set up one specific environment.

EditionAppEditionApp

For example, consider the two Edition Apps developed by the vtex account:

In fact, any VTEX account that meets the requirements needed to be a Sponsor Account can develop and release their own Edition Apps.

Notice that this can be especially useful for complex account families, such as the ones under the same brand or holding.

That's because, besides the fundamental development environment set up by a vtex native Edition App, a Sponsor Account can extend an Edition App by creating a new and customized one that meets its account family needs.

To change the Edition App installed in an account, you must open a support ticket. This is required to avoid critical issues that could be caused by its misconfiguration.

Note that all Edition apps must depend, directly or indirectly, on either vtex.edition-business or vtex.edition-store.

The apps that are part of the Edition App included as a dependency are considered inherited apps.

Despite these, all apps of an Edition App must have the same vendor as the Edition App that bundles them.

Keep in mind that Sponsored Accounts cannot change the apps and configurations installed through an Edition App. Only the Sponsor Account is authorized to do that, by releasing a new version of its Edition App and requiring it to be reinstalled.

To sum it up, by encapsulating all the necessary settings, policies, back-, and front-end apps, an Edition App provides all the essential functionalities to set up one desired environment.

Updated about 17 hours ago


Edition App


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.