> This page is for Developer.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.bigcommerce.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.bigcommerce.com/_mcp/server.

# Publishing an App

After completing development, verifying best practices, and checking approval requirements, you may submit your app for Marketplace approval in the [Developer Portal](https://build.bigcommerce.com/). This article takes you step-by-step through the submission form and provides descriptions for each field.

## Before you begin

Your listing on the [App Marketplace](https://www.bigcommerce.com/apps/) 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](/_fern-img/8e6727d589945d37184bd83dd383df6ba909f04eca22654091b8f091e4d19fb2.webp)

| Field                    | Description                                                                                                                                                                                                 |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Auth                     | Requested when store owner or authorized user clicks `install`                                                                                                                                              |
| Load                     | Requested when user launches app                                                                                                                                                                            |
| Uninstall                | Requested when store owner or authorized user clicks `uninstall`                                                                                                                                            |
| Enable multiple users    | Optionally allow your app to be accessible to store users other than the owner                                                                                                                              |
| Remove user callback URL | Requested when a store owner opts to revoke a user’s authorization to use the app. For more information, see [Supporting Multiple Users](/developer/docs/integrations/apps/guide/supporting-multiple-users) |

## Add OAuth Scopes

In the **Scopes** tab, add any scopes the app requires. For a list, see [OAuth scopes](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).

![Scopes](/_fern-img/219ccf69d68baff20d4251a73a061a77297efe7a9f474b4ab83dc1e8efdbc6b1.webp)

| Field        | Description                                                |
| ------------ | ---------------------------------------------------------- |
| Set manually | Allows explicit selection of the necessary scopes          |
| Modify all   | Sets all scopes to Modify or the most permissive selection |

> **Note**
>
> "Modify All" is for testing only. Apps configured with all scopes will not be approved for public listing in the Apps Marketplace.

| Scope permission | Description                                                                                  |
| ---------------- | -------------------------------------------------------------------------------------------- |
| None             | Removes app access to the scope entirely                                                     |
| Read-Only        | Only grants the app read access for the scope                                                |
| Modify           | Grants the app full access to read, write, create, or delete data                            |
| Create           | Grants the app access to create data                                                         |
| Get              | Grants the app access to read specific data                                                  |
| Token Login      | Allows management of login processes including authentication and session handling           |
| Generate Tokens  | Allows 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](#faq) for more information.

### 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](/_fern-img/47c00a3d76e3c4882190a918d9c08c2d988bfc5dfe9b57f35739269350da92a6.webp)

| Field           | Description                                                                                                                                     |
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| Contact Name    | Email address created when applying for your Partner ID                                                                                         |
| Partner Name    | Name of your company; attributed on the detail page                                                                                             |
| Partner Website | URL to your homepage                                                                                                                            |
| Support Email   | Business mail where users can get help with the app                                                                                             |
| Support Website | Used for **Get Support** button in Marketplace                                                                                                  |
| Partner ID      | Required for submission; assigned to [partners](/developer/docs/integrations/becoming-a-partner#applying-to-the-partner-program) after approval |

### App-supported functions

The supported functions with which the app is expected to be compatible. This has no effect on the function of the app. The selectors in this section enable or disable feature badges on the apps marketplace.

![App-supported functions](/_fern-img/e7a712acca77ded0ed2df835d4c0ef6493188bc90a6ebb90541c4bd9075ded09.webp)

| Field                    | Description                                                           |
| ------------------------ | --------------------------------------------------------------------- |
| Storefront type          | Indicates whether multi storefront is compatible with the app         |
| Multi-location inventory | Indicates whether multi-location inventory is compatible with the app |
| Testing instructions     | Instructions needed to test the app thoroughly                        |

### App Summary

Descriptive information about the app, including the category in which the app should display in the apps marketplace

![App Summary](/_fern-img/2d54be6bfd7d3e18e0a15bbb906fa9c0380d456540bb1b4684020fc419305a8c.webp)

| Field                | Description                                                                                                                                  |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| Short app summary    | A brief description that shows up in search results                                                                                          |
| Full app description | A broad overview of the app including benefits, use-cases, and other information. Displayed on the app’s detail page in the apps marketplace |
| Marketplace category | The 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](/_fern-img/eb2efb8825c7d15f9515303865e50a5a4a6c78d6a94b33782958497918c3e5e2.webp)

| Field           | Description                                                                                                                                          |
| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| App icon        | A square icon with a transparent background. Displays in the Apps menu in the control panel.                                                         |
| Primary logo    | A logo with either white or transparent background that shows the brand logo in the foreground. Displays in search results in the apps marketplace.  |
| Alternate logo  | 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 marketplace. |
| App screenshots | Screenshots of the app as end-users experience it. Displayed on the app’s detail page in the apps 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.

> **Note**
>
> Videos and Case studies are optional fields.

![Videos, Features, and Case studies](/_fern-img/eb2efb8825c7d15f9515303865e50a5a4a6c78d6a94b33782958497918c3e5e2.webp)

| Field        | Description                                                                                                      |
| ------------ | ---------------------------------------------------------------------------------------------------------------- |
| Videos       | Videos highlighting purpose and value of your app                                                                |
| Case Studies | Case studies demonstrating how merchants have benefited from using your app. 4 max                               |
| Features     | App's major features; include title and description for each; title is search indexed; rich text accepted; 5 max |

### Resources and International optimization

Useful resources and locale information for the app.

> **Note**
>
> 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](/_fern-img/4ae2966f6a5ae330af10043fb1d601e775166cbd356ec24597815ff90ad06f3d.webp)

| Field              | Description                                                                                               |
| ------------------ | --------------------------------------------------------------------------------------------------------- |
| Installation guide | A guide for installing the app if there are special considerations the user should take for initial setup |
| User guide         | General guide for users, both new and experienced, for using the app                                      |

### 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.

![Plans and billing](/_fern-img/1495bbf4851f09c38014e85d992e8de5b948748d5cfb8c41fa9f1ad2e69e503d.webp)![Pricing details](/_fern-img/b6bc1caeb484809461917fac024ed40407c21ec19d79a0404b10d628dccc9c06.webp)

## Submit your app for approval

Submit apps for [App Marketplace](https://www.bigcommerce.com/apps/) approval by navigating to the Dev Portal's [Apps overview](https://build.bigcommerce.com/apps), 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](/_fern-img/5ab08f06dd35dc44829f263924269ab714bff6afbb0c10354e0dab6f5c9ab5db.webp)

Review the information in the **Confirm listing information** page.

![Confirm listing information](/_fern-img/bb10197f43ee309390b4cd3cf3d11c31af8151991430620edeae08b94e23f474.webp)

Before submitting your app for approval, it is imperative to adhere to the recommended best practices listed below to ensure the integrity of the app marketplace and keep clients safe.

* Integrate with the [BigCommerce JS SDK](https://github.com/bigcommerce/checkout-sdk-js) for Java-based apps. The SDK effectively allows management of the user’s session, keeping it in sync with the control panel.
* At a minimum, design apps to be cookieless (to comply with Chrome and Safari privacy/ security policies) and instead use JWTs to pass information.
* Never pass sensitive data using query parameters.

After completing all information, then click **Submit app for Review** to pay the review and listing fee and submit the app. Test the app before submitting it to avoid paying additional review fees.

![Payment & Submission](/_fern-img/d32b28b471638099fef820b89726cfedc84c4201ad005227c688b5181a284ac3.webp)

If you have any questions about your submission, email [AppStore@bigcommerce.com](mailto:appstore@bigcommerce.com).

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** field and **Videos** fields are optional.

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

Yes! With the updated fields in the Developer Portal, we're also adding the ability to
preview how these changes will appear on the BigCommerce Marketplace. You will see the option to preview on a new step after Review when editing your listing.

**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](mailto: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.

## Next steps

[Review the App Marketplace listing guide (PDF)](https://grow.bigcommerce.com/rs/904-GSB-901/images/Updated_List_of_App_Fields_for_Tech_Partners.pdf)

## Resources

### Sample apps

* [Node / React / Next.js](https://github.com/bigcommerce-edu/starter-sc-app-next)
* [Python / Flask](https://github.com/bigcommerce/hello-world-app-python-flask)
* [PHP / Silex](https://github.com/bigcommerce/hello-world-app-php-silex)
* [Ruby / Sinatra](https://github.com/bigcommerce/hello-world-app-ruby-sinatra)
* [Laravel / React](https://github.com/bigcommerce/laravel-react-sample-app)

### Tools

* [Node API Client](https://github.com/bigcommerce/node-bigcommerce/)
* [Python API Client](https://github.com/bigcommerce/bigcommerce-api-python)
* [PHP API Client](https://github.com/bigcommerce/bigcommerce-api-php)
* [Ruby API Client](https://github.com/bigcommerce/bigcommerce-api-ruby)
* [Ruby OmniAuth Gem](https://github.com/bigcommerce/omniauth-bigcommerce)
* [BigDesign Developer Playground](https://developer.bigcommerce.com/big-design)
* [Figma Component Library](https://www.figma.com/community/file/1359989842592268260/bigdesign-component-library)

### Blog posts

* [How to Test App Authentication Locally with ngrok](https://medium.com/bigcommerce-developer-blog/how-to-test-app-authentication-locally-with-ngrok-149150bfe4cf)
* [Building a BigCommerce App Using Laravel and React](https://medium.com/bigcommerce-developer-blog/building-a-bigcommerce-app-using-laravel-and-react-711ceceb5006)
* [BigDesign Tutorial](https://medium.com/bigcommerce-developer-blog/bigdesign-build-native-looking-uis-with-the-bigcommerce-design-system-fb06a01a24f2)