Testing your app before submitting
Before you submit your app for review, you need to test it on a development store to check for any bugs or errors. Many Shopify merchants depend on apps, so it's important that you make sure your app doesn't include any errors that could negatively impact merchants’ businesses.
The app review team will only review production-ready apps. If you submit an app that is incomplete, is in beta, or has errors that prevent us from reviewing its features, then it will be rejected.
After you've tested your app and made sure that it has met all of our app requirements, you can submit your app for approval. These instructions apply to all public apps, whether they are listed or unlisted in the Shopify App Store.
Best practices for testing your app
When testing your app, think about what it might look like through the eyes of Shopify merchants of varying skill levels. You should make sure you have accounted for any issues that might occur when a merchant installs your app on their store. Here are some suggestions of what to look for when you test your app:
Make sure that the installation process is easy to understand and execute:
- If your app requires code changes, then you should use automated installation resource such as script tags, or assets to insert and remove code snippets.
- If your app requires the setup of an external service to function, then include this within your documentation. For tips on writing instructions for your app, refer to our help documentation guidelines.
Verify that your app can appropriately handle issues like 404s, unexpected inputs, and heavy user traffic.
If your app interacts with or adds something to a merchant’s online store, then test your app with several different Shopify-made themes.
After you’ve installed your app on a development store, make sure you can uninstall and reinstall that app on the same shop.
Installing an app on a development store
When a merchant installs your app, it must first authenticate with the merchant’s shop using OAuth. You can test this by installing your app on a development store. If you don’t have a development store, then you can create one.
- Log into your Partner Dashboard.
- In your Partner Dashboard, click Apps.
- Click the name of your app to navigate to the App overview page.
- Click More actions > Test on development store.
- Select the development store you want to use.
- Click Install app.
You should now be directed to the OAuth screen. If you don't see the OAuth screen, then you might need to double check your app’s code, as well as the app URLs and redirects.
Checking your app's URLs and redirects
Before submitting your app, make sure to test your app’s URLs and redirects. Before submitting your app, make sure its App URL and Allowed redirection URL work correctly. If your app does not redirect merchants to the OAuth screen, your app will be rejected.
- In your Partner Dashboard, click Apps.
- Click the name of your app.
- On your app's page, click App setup.
- Find the URLs section.
- Review and test the URLs you provided.
For more information about using OAuth to communicate with Shopify, refer to Authenticate with OAuth.
Testing your app’s billing system
All charges associated with apps submitted to the Shopify App Store must use the Shopify Billing API. You need to test your app's billing system before you submit your app to the Shopify App Store. To test your app without incurring a real charge, you can have your app create a test charge before you install it on your development store.
To have your app to create a test charge, you can change your app's charge requests to include
"test": true. This will create a test charge when you install the app on your development store so that you don't incur a real charge on your account.
To have your app create a test charge, you can change your app's charge requests to include
"test": true. This will create a test charge when you install the app so that you don't incur a real charge on your account.
Testing your app's performance
Before you upload your app to the Shopify App Store, you must test your app's performance to verify that it doesn't reduce Lighthouse performance scores by more than 10%.
To improve your app's performance, refer to App performance recommendations.
Next: Submitting your app - If you've followed all of the requirements to create your app, then you're ready to submit your app for review by the Shopify app review team.