Skip to navigation

Types of Apps

BigCommerce apps install through a single-click flow that uses OAuth. Once you register an app in the Developer Portal, it moves through a set of states as you test it, submit it for approval, and publish it. This page describes how single-click installation works and what each state means for who can install your app.

Single-click apps

Single-click apps use the OAuth 2.0 Authorization Code Grant (oauth.net) flow. Users start the installation by clicking Install.

Install App

The app asks the user to grant the permissions that match the scopes you configured for the app in the Developer Portal.

App Permissions

After the user grants them, the app can request a permanent access_token to make REST API requests on the user’s behalf. For the full flow, see Implementing OAuth.

Single-click apps can use app extensions.

App states

An app is in one of the following states. The state controls which stores can install it and whether it appears in the App Marketplace.

StateDescriptionWho can install it
DraftYou registered the app in the Developer Portal but haven’t submitted it for approval.The store owner or a user with the Install Applications permission, in a store where the app owner’s email address is registered. Draft apps appear in the store’s control panel under Apps > Develop.
Under reviewYou submitted the app for approval and the Marketplace team is reviewing it.Not available to other stores. Keep testing with your draft installation.
PublishedThe Marketplace team approved the app, and it is listed on the App Marketplace.Any BigCommerce store.
UnlistedThe Marketplace team approved the app, but it isn’t listed on the App Marketplace.Any store that has the app’s direct installation link.

Draft apps

Every app starts as a draft. You can create and install draft apps without being a BigCommerce partner, so draft apps are the best way to build and test. You can install your draft app in any BigCommerce store you own. For steps, see Testing your app.

You can keep an app as a draft indefinitely. A draft app can’t be installed on stores that don’t have your email address registered as the store owner or as a user with the Install Applications permission. To make the app available to other stores, submit it for approval.

Apps under review

When you submit an app for approval, the app shows as Under review in the Developer Portal. The Marketplace team tests it against the approval requirements and sends you feedback. For what to expect and how long each step takes, see Publishing apps.

Published apps

When your app is approved, it is published. A published app is listed on the App Marketplace and any BigCommerce store can install it. You can also sell the app on the Marketplace.

After an app is published, it no longer appears under Apps > Develop in your store. To open or manage a published app, sign in to the Developer Portal.

Unlisted apps

An unlisted app is a pre-launch app, such as an app in a beta period. It is approved and available to install through a direct link, but it doesn’t appear in the App Marketplace.

Unlisted apps aren’t a way to distribute an app outside the Marketplace program. An unlisted app goes through the same review as a published app and must meet all of the same approval requirements. Only approved partners who have signed the partner agreement qualify, and BigCommerce treats an unlisted app like any other published app.

To request unlisted status, submit the app for approval as usual and note in the Test instructions field that you intend the app to be unlisted. For more information about submitting, see Publishing apps.

Next steps

Resources