Documentation
Feedback
Guides
App Development

App Development
VTEX App Store
Submitting your app to the VTEX App Store

Learn how to submit your app for distribution in the VTEX App Store.

From the release of Extensions Hub, we changed our terms of service to enable VTEX partners to promote and sell their apps in the App Store. Thus, we created an addendum in the contract with partners, considering the app monetization and the new payment flow.

Due to changes in our internal procedures, we applied temporary restrictions related to publishing apps in the App Store:

  • Partners that already have published apps and still did not sign the new contract with the addendum must sign it as soon as possible.
  • Only partners that already signed the new contract can publish apps as usual, following the homologation process.
  • We are not accepting new partners for publishing apps in the App Store.

Learn how to successfully submit your app for distribution in the VTEX App Store by following this guide. The VTEX App Store is a marketplace where VTEX clients can discover and install applications that enhance their ecommerce experience. Before your app can be featured in the VTEX App Store, it must pass the homologation process, which involves evaluation in three key areas: business, user experience (UX), and security/performance. This process applies to all apps, regardless of their functionality, such as storefront, admin, backend, or pixel.

Keep in mind that the homologation process may take 45 days from the moment the app data is sent for validation.

Edition apps do not need to be published in the App Store. Instead, accounts that wish to develop their own Edition apps must fulfill the requirements to become a Sponsor Account.

Before you begin

Technical requirements

To complete this guide, you will need:

  • GitHub account: The app homologation is conducted via GitHub and Pull Requests (PR). Ensure you have a GitHub account.
  • VTEX IO CLI 3.x: Ensure that the VTEX IO CLI is updated to version 3.x. For instructions, refer to Updating VTEX IO'S CLI.

App prerequisites

Before proceeding with the homologation process, ensure your app meets these prerequisites:

App Store prerequisites

Finally, before submitting your app to the VTEX App Store, ensure you've completed the following steps:

Instructions

Step 1 - Submitting the app for validation

  1. Open the terminal and log in to the VTEX account corresponding to the app's vendor account using the VTEX IO CLI 3.x.
  2. Change to your app's directory.
  3. Install the submit plugin:

    _10
    vtex plugins add submit

  4. Submit your app for the homologation process by running the following command. You can also specify which version to submit by running vtex submit {vendorAccount}.{appName}@{appVersion}.

    _10
    vtex submit

  5. When prompted, enter the GitHub username that will manage the homologation process. In the following, provide the workspace URL the VTEX team can use to test your app.

{"base64":"  ","img":{"width":1560,"height":782,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":185032,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store-0.png"}}

Step 2 - Managing the homologation process

After completing these steps above, a GitHub repository will be automatically created for your app, and you will be prompted with a PR link in the terminal (e.g., https://github.com/vtex-reviews/{vendorAccount}.{appName}). The specified GitHub account will be added to the repository with read-only permissions to follow your app's review process. Comments and adjustments can be made in the same repository.

The homologation process applies to both new apps and new major versions of apps. A new branch will be created in the repository for each new app version.

You can work on improvements in a new branch. When the branch has the necessary adjustments, open a PR to the VTEX team for review.

{"base64":"  ","img":{"width":1996,"height":1736,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":317165,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store-1.png"}}

Step 3 - Waiting for the app homologation

After opening the PR, the VTEX team will validate it for approval and merging. The PR will be approved when the app fulfills the VTEX App Store guidelines and your new app version will be ready to be released and made available in the VTEX App Store.

Please note that after the homologation process is completed, a product will be automatically created in your store catalog. Do not remove or modify it, as this product is what integrates your app with the VTEX App Store marketplace.

Contributors
1
Photo of the contributor
+ 1 contributors
Was this helpful?
Yes
No
Suggest edits (Github)
See also
App monetization
App Development
User Experience guidelines
App Development
Marketing guidelines
App Development
Engineering best practices
Guides
Contributors
1
Photo of the contributor
+ 1 contributors
On this page