Skip to main content

Introduction

What are Shoptet add-ons?

Shoptet Add-ons are custom extensions that developers can create to enhance the functionality of Shoptet e-shops. Add-ons can be used to customize the look and feel of a store, add new features, or integrate with third-party services. Shoptet Add-ons are monetized through the Shoptet Marketplace, where developers can submit their add-ons for sale or distribution.

Getting Started

I have an idea for an add-on. What should I do?

All add-on proposals must be sent to us via this form. New add-on proposals are evaluated internally every two weeks. Along with our colleagues, we assess whether the add-on fits into our product roadmap, marketplace strategy, etc.

After your add-on proposal is evaluated, our Marketplace Account Manager will contact you with the result (approved/denied).

What type of add-on can I create?

Shoptet supports various types of add-ons to extend the platform's functionality:

  • Templates: Custom themes that alter the look and feel of a Shoptet store, primarily using CSS and JavaScript customization.
  • Integrations: Add-ons that connect Shoptet with third-party services like CRM, ERP, marketing tools, or shipping providers. These use the Shoptet API to communicate with third-party services.
  • Widgets: Dynamic components that can be added to a store’s frontend. Widgets combine visual customization and API calls to add new features.

My add-on proposal was approved. What's next?

Once your add-on is approved, our Marketplace Account Manager will contact you regarding further cooperation. To begin development, you must become a Shoptet API partner, which requires signing a contract and accepting our Terms and Conditions.

After signing the contract, we will provide you with a free test e-shop, API access, and an API Partner admin section for managing your add-ons. Our Marketplace Project Manager will be available for consultation throughout the development process.

Add-on Development

How to start developing an add-on?

After signing the API Partner contract, we will provide you with a free test e-shop and a special API Partner admin section with API access details. Here, you can create and manage your add-ons.

Shoptet doesn't provide a dedicated development environment for add-ons. You can start developing your add-on locally and test it on your Shoptet store using our developer tools.

For the visual aspect of your add-on, you can use the Shoptet Addon Boilerplate or our Postman collection for API.

For more information about the development process, see [LINK to API section].

Are there any guidelines for add-on development?

When developing an add-on, it is essential to follow our API guidelines [LINK: API guidelines] to ensure optimal use of resources. This avoids overloading the API and ensures a smooth final review of your add-on on our side (we always check the API activity of the add-on).

Additionally, follow our frontend guidelines [LINK: FE guidelines] to ensure source code accessibility, readability, and adherence to performance requirements.

What are the deadlines for submitting an add-on?

According to our T&C, your add-on must be submitted for final approval within 6 months of signing the contract.

What if I need to consult about the add-on development?

If you need consultation or have questions about add-on development that are not addressed in our documentation, please email api@shoptet.cz. Our Marketplace Project Manager will assist you.

I have completed the add-on development. What are the next steps?

Once your add-on development is completed and thoroughly tested, submit it for final approval by clicking the "Submit to approval" button in the add-on administration section. Additionally, send all required information mentioned here [LINK: Add-on lifecycle - Review process] to api@shoptet.cz.

Continue below to learn more about the review process.

Add-on Review Process

What is the add-on review process?

Every add-on must undergo a final review on our side, which includes basic user tests, API activity checks, and verification of custom codes.

When submitting the add-on for approval, ensure you send all required information and documents specified here.

Our Marketplace Project Manager will provide feedback and outline the next steps.

Please note that the review deadline on our side is four weeks from the submission of the add-on for approval.

Are there any review process requirements?

Before submitting your add-on for final review, thoroughly test it to ensure compliance with our guidelines and that it is production-ready. Add-ons that are incomplete or contain significant issues (e.g., installation not working) will not be reviewed.

To facilitate the review process, submit the following when requesting approval (in CZ, SK, or ENG):

  • Step-by-step setup instructions: Provide clear setup and configuration instructions, including external setup details with test credentials if required.
  • Manual or demo video of main use cases: To ensure proper testing, provide a demo video or detailed manual outlining the primary functionalities for review.
  • List of API endpoints: Include a list of API endpoints used by your add-on (based on our API documentation), with explanations of their purpose and frequency of use. For example: "The add-on requests order detail (GET api/orders/{code}) after receiving the order:create webhook notification to ensure real-time synchronization of data."

Add-on Launch

  • Medallion
  • Pricing strategy
  • Add-on support
  • Marketing
  • Launch

Add-on Reviews

Add-on users can leave reviews after installation, rating it from 1–5 stars and adding comments. All reviews are transparently displayed on the Shoptet Marketplace.

You can manage reviews in the API Partner section of your testing e-shop. It is highly recommended to respond to all reviews, especially negative feedback, and provide support to users who need it.

Encourage users to leave reviews, as positive reviews enhance credibility and can lead to increased installations.