Skip to main content

Publishing

Publishing your Shop Mini to the Shop app includes a manual review process. You can use the submit command to create a submission, which will upload your source code and initiate a review. Once your submission has been approved, your Shop Mini will be made available to users in the Shop app.

Anchor to requirementsRequirements

CommandLearn more about the setup command

Anchor to submittingSubmitting your Mini

Use the submit command to submit your code for review.

You'll need to enter a description to tell us what your Shop Mini does and any changes since your last submission. Please provide a video showing an end-to-end flow of your Shop Mini. This will help provide our team with more clarity during the review process.

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.

If it's approved, your Mini will be made available to users in the Shop app when the Shop Team decides to release it.

If it's rejected, we'll provide detailed actionable feedback to assist with your next submission. If you have questions or concerns about the outcome of a review, please talk to the Shop Minis team in the #shop-minis channel in the Shopify Partners Slack Community.

Submission requirements

Submissions have a maximum size of 1.5MB and must include a src/icon.png file, which should be 1024x1024px and less than 200KB.

Submit your Mini

npx shop-minis submit [options]

Anchor to keeping-up-to-dateKeeping your Mini up to date

Your Mini must use a compatible SDK version to work with the Shop app. You should upgrade your Mini to the latest SDK version:

  • Before making a new submission - Submissions with outdated SDK versions will be rejected
  • When requested by Shop Minis team - If we ask you to upgrade due to compatibility issues

Use the upgrade command to update your Mini to the latest SDK version:

CommandLearn more about the upgrade command

Upgrade your Mini

npx shop-minis upgrade [options]

Anchor to checking-statusChecking the status of a submission

Use the check-submission command to see details about your latest submission.

Check the status of a submission

npx shop-minis check-submission [options]

Anchor to cancellingCancelling 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 with the cancel-submission command.

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.

Cancel a submission

npx shop-minis cancel-submission [options]

Anchor to updatingUpdating 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.