Skip to navigation

Publishing an App

After completing development, verifying best practices, and checking the approval requirements, you may submit your app for Marketplace approval in the Developer Portal. This article takes you step-by-step through the submission form, describes each field, and explains what happens after you submit. For the standards your app and listing are reviewed against, including image sizes and character limits, see the approval requirements.

Before you begin

You need an active Technology Partner account and your Partner ID. For the full list of account requirements, see Before you submit.

Your listing on the App Marketplace plays a major role in your app’s success. A good listing accomplishes three goals:

  • Shows users how your platform or solution differs from competitive offerings
  • Includes keywords so prospective users can find your listing in searches
  • Sets up clear and accurate user expectations as to your solution’s features and functionality

Before you begin completing the app registration, we recommend prepping the following assets:

  • Company logos
  • Screenshots and video content
  • Case studies

We also recommend giving special attention to the following search indexed fields:

  • App name
  • App summary
  • App category

Provide technical information

In the App information tab, provide the relevant technical information required for the app’s functionality. Specify callback URLs and multiple user support. This tab also provides the app’s API credentials.

App information

FieldDescription
AuthRequested when store owner or authorized user clicks install
LoadRequested when user launches app
UninstallRequested when store owner or authorized user clicks uninstall
Enable multiple usersOptionally allow your app to be accessible to store users other than the owner
Remove user callback URLRequested when a store owner opts to revoke a user’s authorization to use the app. For more information, see Supporting Multiple Users

Add OAuth Scopes

In the Scopes tab, add only the scopes the app requires. For a list, see OAuth scopes. For how scopes are reviewed, see Installation and Security and checkout.

Scopes
FieldDescription
Set manuallyAllows explicit selection of the necessary scopes
Modify allSets all scopes to Modify or the most permissive selection

“Modify All” is for testing only. Apps configured with all scopes will not be approved for public listing in the App Marketplace.

Scope permissionDescription
NoneRemoves app access to the scope entirely
Read-OnlyOnly grants the app read access for the scope
ModifyGrants the app full access to read, write, create, or delete data
CreateGrants the app access to create data
GetGrants the app access to read specific data
Token LoginAllows management of login processes including authentication and session handling
Generate TokensAllows generation of access tokens used to access storefront or customer account information

Add listing information

In the Listing information tab, add basic information and finer details about the app. This includes support, pricing, style and much more information. The various fields are grouped by similar data, as outlined below.

While no fields are explicitly required for private apps, most are required for publication. See the FAQ for more information. For image sizes, character limits, and other listing standards, see Listing requirements.

Marketplace profile

The Marketplace display information that directs end-users to contact and support information for the app as well as partner-specific information.

Marketplace profile
FieldDescription
Contact NameName of the person who owns or manages the app
Partner NameName of your company; attributed on the detail page
Partner WebsiteURL to your homepage
Support EmailBusiness mail where users can get help with the app
Support WebsiteUsed for Get Support button in Marketplace
Partner IDRequired for submission; assigned to partners after approval

App-supported functions

The storefront features with which the app is compatible. These selections have no effect on how the app runs. Selecting a feature requests a compatibility review, and the matching feature badge appears on your Marketplace listing after the app passes it. For the standards each review uses, see Compatibility badges.

App-supported functions
FieldDescription
Storefront typeIndicates whether the app is a Single Storefront app or is compatible with Multi Storefront. For guidance, see Optimizing multi-storefront apps.
Multi-location inventoryIndicates whether multi-location inventory is compatible with the app. For guidance, see the Buy online, pick up in store FAQ.
Catalyst compatibleIndicates whether Catalyst is compatible with the app. For guidance, see Building Catalyst-compatible apps and integrations.
Testing instructionsInstructions needed to test the app thoroughly

App Summary

Descriptive information about the app, including the category in which the app should display in the App Marketplace

App Summary
FieldDescription
Short app summaryA brief description that shows up in search results
Full app descriptionA broad overview of the app including benefits, use-cases, and other information. Displayed on the app’s detail page in the App Marketplace
Marketplace categoryThe category in which the app should be placed. Improves visibility for users looking for particular types of apps.

Media assets

Logos, icons, and screenshots of the app that provide unique branding and user expectations.

Media assets
FieldDescription
App iconA square icon with a transparent background. Displays in the Apps menu in the control panel.
Primary logoA logo on a white background that shows the brand logo in the foreground. Displays in search results in the App Marketplace.
Alternate logoOptional. A logo with a solid color background and the brand logo in the foreground. Displays in the featured apps if your app is featured on the App Marketplace.
App screenshotsScreenshots of the app as end-users experience it. Displayed on the app’s detail page in the App Marketplace.

Videos, features, and case studies

Relevant videos of app functionality, features that users will find appealing, and case studies that demonstrate the app’s usefulness.

Videos and Case studies are optional fields.

Videos, Features, and Case studies
FieldDescription
VideosVideos highlighting purpose and value of your app
Case StudiesCase studies demonstrating how merchants have benefited from using your app
FeaturesApp’s major features; include title and description for each; title is search indexed; format descriptions with the rich text editor rather than pasting markdown or HTML

For limits and content standards, see Features and case studies.

Resources and International optimization

Useful resources and locale information for the app.

Company privacy policy and Company terms of service are required for legal reasons and should be included. Apps without these items will not be listed in the Marketplace until this information is provided.

Resources and International optimization
FieldDescription
Installation guideA guide for installing the app if there are special considerations the user should take for initial setup
User guideGeneral guide for users, both new and experienced, for using the app
International optimizationOptional. Describe the regions your app is optimized for, or where it isn’t supported.

Provide at least one guide. For what the review checks, see Legal pages and guides.

Plans and billing

Relevant pricing information. If your app has a free trial period, upfront costs, or monthly costs, these can be added after selecting the correct pay structure. For how to choose a pay structure, see Pricing requirements.

Plans and billing
Pricing details

Submit your app for approval

Submit apps for App Marketplace approval by navigating to the Developer Portal’s Apps overview, then finding the app you want approved and clicking the Publish app… option from the action menu to the right of its listing.

Menu - publish

You can also submit the app from the app editor. Open the app, then select App Actions > Publish to App Marketplace….

App Actions menu - Publish to App Marketplace

The Submit app for review dialog shows the Marketplace profile information for your app. Review it, then select Submit app.

A payment window opens for the $99 review and listing fee. Pay the fee to complete your submission. The app isn’t submitted until the payment is complete. If you close the window before paying, reopen the publish dialog to finish submitting.

Before you submit, check your app against the approval requirements, including the recommended practices that keep the Marketplace secure for store owners. Test the app before submitting it to avoid paying additional review fees.

If you have any questions about your submission, email AppStore@bigcommerce.com.

What happens after you submit

  1. Review begins. The app’s status in the Developer Portal changes to Under Review and stays there until the review is complete. The Marketplace team installs the app in a test store and checks it against the approval requirements.
  2. You receive feedback. If the app needs changes, the Marketplace team emails a PDF report of the findings to the app’s owner in the Developer Portal and to the primary contact on your partner account. Reply to that email with questions or to continue the conversation.
  3. You update the app and request a re-review. Fix the findings, then reply to let the Marketplace team know the app is ready to be reviewed again. The team doesn’t reject an app between rounds of review as long as you keep responding.
  4. The app is approved and published. The app is immediately installable through its single-click URL. Its Marketplace listing can take up to 24 hours to appear.

After the app is published, it no longer appears under Apps > Develop in your store. To manage it, use the Developer Portal or the app’s single-click URL.

Response timelines

To ensure a timely app review and Marketplace quality, BigCommerce enforces response timelines for app review cases.

  • Partners must respond within 30 days of receiving feedback.

  • Non-responses result in app rejection due to inactivity.

  • If the app is resubmitted within 30 days and shows progress, no additional fee will apply.

  • After 30 days, a new submission and fee are required.

FAQ

Are all fields required?

For Marketplace approval, you’ll need to fill out all fields on your listing with applicable content and links. These will be reviewed as part of the Marketplace approval process. The Case Studies, Videos, and Alternate logo fields are optional. For the standards each field is reviewed against, see Listing requirements.

Am I able to preview the changes to my listing before publishing them?

Yes. When editing your listing, the step after Review lets you preview how your changes will appear on the BigCommerce Marketplace.

Is there a draft status for these changes, or will saving make them live?

Any changes you save will take effect immediately, so make sure you’re ready to push them out to the Marketplace before saving.

I’ve logged in to the Developer Portal, but I don’t see my published listing. Where is it?

You may have logged in with the wrong account. Each listing can only be owned by one user, so it is likely assigned to another email address. If you’re unable to track down the correct owner account for your solution, please reach out to appstore@bigcommerce.com.

I saved my changes, but my listing has not updated yet. What’s the problem?

The changes will be effective immediately in your control panel app card, but the updates can take up to 24 hours to appear on the App Marketplace. Feel free to use this as a grace period to make edits as needed.

Resources

Sample apps

Tutorials

Tools

Blog posts