Publishing

info

Publishing is only available to early access partners. Apply here to join the early access program.

Publishing your Shop Mini to the Shop app includes a manual review process. You can use the CLI to create a submission, which will upload your source code and initiate a review. Once you submission has been approved, your Shop Mini will appear in an upcoming release of the Shop app.

Requirements

• You have a Shop Mini ready for review
• You have a Shop Minis Admin API key. If you don't already have an API key, you can request one in the partners issue tracker.

Submitting code for review

1. Configure your API key in .env in your Shop Mini directory:

   echo "SHOP_MINIS_API_KEY=<your-shop-minis-admin-api-key>" > .env

2. Submit your code for review:

   npm

   npx shop-minis submit

   Yarn

   yarn shop-minis submit

   You'll need to enter a description to tell us what your Shop Mini does and any changes since you last published.

At this point, your source code will be uploaded for us to review. Once we've reviewed your submission, we'll either approve it or ask you to make some changes. Use the contact_email field in the manifest.json to configure which address we send review notifications to.

If it's approved, it will be included in an upcoming release of the Shop app. New app versions are released regularly and should be live within 7-10 days.

If it's rejected, we'll provide detailed actionable feedback to inform your next submission. If you have questions or concerns about the outcome of a review, please talk to the Shop Minis team.

Checking the status of a submission

You can use the check-submission command to see details about your latest submission:

npm

npx shop-minis check-submission

Yarn

yarn shop-minis check-submission

Cancelling a submission

If you realize there is an issue with the code you have submitted or you change your mind, you can cancel a submission:

npm

npx shop-minis cancel-submission

Yarn

yarn shop-minis cancel-submission

This will only work for pending submissions—if we have already reviewed the submission, you'll need to make a new one. Please contact us if we have approved a submission that you later realize includes a bug.

Updating a submission

It's not possible to update a pending submission. If you'd like to make changes, you'll need to cancel the pending submission and make a new one.

There can only be one pending submission at a time, you cannot line up multiple submissions. You should either cancel and combine the changes into a single submission or wait for the pending submission to be reviewed first.