Extensions
Overview
Here you will find everything you need to know about creating and maintaining extensions.
What are Shopware 6 extensions based on the App system?
Shopware 6 extensions based on the app system are extensions developed specifically for the cloud version. They are also displayed by this selection in the store directly under the Shopware 6 category and can be filtered by "Usable in Cloud".
What are Shopware 6 extensions based on the Plugin system?
Shopware 6 extensions based on the plugin system are extensions developed specifically for the onPrem version. They are displayed in the store directly under the Shopware 6 category.
What are Shopware 5 extensions?
Shopware 5 extensions are extensions and themes specially developed for Shopware 5, which are also displayed in the store as Shopware 5 extensions.
What is a successor extension?
Successor extensions are Shopware 6 extensions that continue the functionality/features of your existing Shopware 5 extensions also under Shopware 6. When upgrading from 5 to 6, the customer can transfer the already used feature during the shop relaunch.
Why is there a difference between Shopware 5 and Shopware 6 extensions?
Since Shopware 6 relies on a completely new technical basis, a Shopware 6 extension is a completely separate product in the Shopware Store. This means that updating an extension from version 5 to version 6 is impossible.
How to upload an extension successfully?
To upload your app successfully, it is most important to have a detailed look at our Quality Guide beforehand. There you will find all the essential information you need for the process.
What do the statuses mean in my extension overview?
Incomplete
Your extension details are not complete. Click on Details to get to the app details. The fields marked in red indicate which data is missing.
Code review required
No code review has been requested for at least one version of your extension. You can do this under Versions as soon as you have filled in all extension details.
Code review failed
Your extension failed the automated code review. The version of your extension contains technical feedback on what has failed. You can also upload a new version and restart the code review.
Pending approval
Your extension has passed the automated code review and is waiting to be tested manually by Shopware.
Rejected
Your extensions was rejected by Shopware. For questions, please send an email to qa@shopware.com.
Approved
Your extension has been reviewed and approved by Shopware. You can now enable it for the store in the master data under Publish extensions.
In store
Your extension has already been approved and is available in the Shopware Store.
Deleted
You have deleted the extension.
What is the purpose of automatic compatibility with version releases?
This option should generally be enabled for app system-based applications. If this is the case, your app will be automatically marked as compatible with new minor versions.
Minor versions are released by Shopware at regular intervals and do not introduce any groundbreaking changes to the public API. Enabling this option is important because minor versions are released in the cloud earlier than a regular version.
By automatically marking the app as compatible with new minor versions, it ensures that the app remains available to your customers. Apps that are not marked as compatible will not be displayed in the store.
Test environment
Since 27.10.2021, it has been possible for Extension Partners to create a test environment from the account.
This test environment is based on Docker. The environment can be created if the extension was submitted after 27.10 or returned after 27.10 for rework by the Testing Team. The test environments are both Cloud and onPrem compatible and are only available for SW6 extensions.
How can I create a new extension?
Once you have accepted the Extension Partner contract, and this has also been accepted by Shopware, you will be able to use the Extension Partner section in the account.
Go to extensions > Create new extension to get to the extension details where you can upload your extension and update the information about it.
What is the status overview in my extension details?
Your extension status overview contains important information about your extension life cycle and “errors”.
The Life cycle shows the current status of your extension. You will see different messages in the info box:
“Errors found” shows which fields have not yet been completed.
Your extension was denied. Why can this be?
The life cycle shows the current status of your extension. The “Errors” info box contains various messages about what is missing in the extension details. In addition, there are several reasons why an extension has not yet made it into our store. Besides an inadequate code quality according to our Quality Guide → Quality Guide and the automatic code analysis (static and qualitative), the reason can also be related to contract requirements (STP contract is missing). Please feel free to contact us with any questions: qa@shopware.com
Another possible reason for the rejection of an extension could be the failure to meet the established release requirements; you can find more information about this here.
What to consider when cancelling an extension version
Only possible within the first 3 days after upload
You will receive information on how often the update has been downloaded by your customers
If no downloads have taken place yet, the update will be deleted
If a customer has already downloaded the version, it is marked as "cancelled"
The version is no longer available in the store and is not suggested as an update in the backends
The version is left blank in the customer account
Only the extension Extension Partner and Shopware see the cancelled extension version
What is the extension certification?
We use certificates to mark particularly high-quality extensions with a bronze, silver or gold seal. Excellent extensions have been carefully checked by Shopware, especially with regard to their quality and support.
More information about the respective seals can be found here.
How can I get my extension certified?
Your extension will automatically be checked for the next highest certification level. You can see the available certification level directly in your extension details at the top under extension certification.
If your extension has reached a certification level, you can go to Marketing in your extension details to have your certification displayed and draw more attention to your extension in the store.
Which extension certifications are there?
Your extension can have the Bronze, Silver or Gold certifications. Information on the respective seals can be found here.
Why does the extension certification cost money?
The extension certification is a separate and detailed review of your extension by shopware, which is listed separately with a badge. Excellent extensions get a much higher visibility in the store.
Where can I see which certification level my extension has reached?
Look for extension certification in the second section of your extension details. The percentage display shows exactly how many percentage points you need to get to the next level.
The certification criteria define which points are required to get to the next certification level.
If any point in the certification criteria of the already achieved certification is no longer met, the certificate would be downgraded after 28 days.
When does my extension require a Shopware technology agreement?
If your extension is a software extension/interface with downstream costs/transaction fees/service fees for the customer, you will need our Technology partner agreement to activate your extensions.
We will be happy to help you with this! If you have any questions about the technology partner agreement, please contact our Sales Team via mail: alliances@shopware.com
How can I request a preview?
In your Extension Partner area in the extension itself, you can request a preview. Please maintain your extension with the description, the translation, etc. before. A confirmed preview is then, at the same time, the reservation of the function in our store.
What exactly does preview mean? What are the benefits?
With the preview, you can promote your extension before its release in the Shopware Store. The preview is listed in the "Coming soon“ category and can be found via search.
What is needed for a preview?
We need the app's description (with images) and a planned release month for the preview.
Where and how can you request a preview?
Go to the Extension Partner area, select the desired extension, and request the preview. You can find the place under "Preview in Shopware Store".
Second you will need to fill in all categories to be able to request a preview so :
The planned release month
The areas of Master Data
Descriptions and Images
Categorization
Once everything has been filled in, we will check it, and you will get feedback in one week's business.
Once the preview is approved, you will get a message on preview in the Shopware Store, and your extension will be visible to our customers in the store.
If your preview is rejected, our Store QA will contact you to see what steps are necessary to allow you a preview.
Do I need an SDK license for extension development?
You need an SDK license if you develop extensions with backend components for Shopware 5 and want to offer them under a proprietary license (i.e. extensions that are not licensed under the GNU Affero General Public Licence Version 3 or a compatible license). These can be purchased directly through us →
https://store.shopware.com/en/swag187921076273/shopware-5.0-sdk-licence.html
Extension details
What are the master data?
The extension master data contains all the basic data for your extension :
Activating and publishing your extension in the Shopware Store
Presenting your technical extension name
Default language: which language is the default one in your extension
Extension availability: here, you can decide whether the extension should be available in the German store and/or international stores.
Creation date: when was your extension created?
Extension item number
License: which licensing model your extension has (proprietary, MIT, LGPL, GPL v2, GPL v3, New BSD)
What is a technical extension name?
The technical extension name is the name used in your extension. It always starts with the Extension Partner prefix and can’t be changed after the extension has been published, as it has an effect on your customers’ licensing.
Can I change the technical extension name?
Since the technical extension name has an effect on your customers’ licensing, it can’t be changed later.
Why is there an extension item number in addition to the technical name?
Shopware automatically assigns the extension item number to identify the extensions in the store clearly. After an extension is deleted, the item number can’t be reassigned, as opposed to the technical name.
How can I display in the store that my extension has also been translated into other languages?
The languages can be entered in your extension details under “Description & images”. They show the customers in which languages your extension is translated and are also displayed in the store under your extension details.
How can I activate my extension in the international store?
Simply click on the “Available in international store” button in your extension details under “Master data” in your account. After saving, your extension will also be displayed in the international store.
When will my extension be approved?
For your extension to be approved, it must pass several tests and meet certain conditions.
1) It has to contain all necessary information.
2) It has to pass the automated code review
3) It has to pass our manual test (Quality Guide).
4) If it is an interface, you may need to sign a Shopware technology agreement.
5) If you develop a backend component, including the commercial use of ExtJs, you will need an SDK contract to publish the extension.
If you have any questions, please contact qa@shopware.com.
What is the automated code review?
The code for your extension is checked automatically by Shopware. In addition to the general code review, we will also carry out the static and qualitative code analysis. We use the tools PHP Stan and Sonarqube for these checks.
What do “Warnings” in my extension code review mean?
“Warnings” are indications of anomalies in static and qualitative code review performed using the tools PHP Stan and Sonarqube. They help you increase your code quality, identify potential security gaps, and improve compatibility (e.g. for certain PHP versions) or avoid problems.
How can I indicate (faster) that my extensions are compatible with the latest Shopware minor version?
Use the “Compatibility Wizard” in your extension details to do this. It can be enabled by clicking on the “Individual minimal Shopware version” button in the “Marketing” section.
Do I have to modify my extension's compatibility with each update manually?
No, you can enable the Compatibility Wizard to do this:
Just click on the Individual minimal Shopware version button in the Marketing section. This way, all Shopware versions below the one you select will no longer be displayed on the extension detail page under Compatible with and will also be taken into account when filtering by category.
Description & images
Where does the display name of my extension appear? Can I change it at any time?
The display name is used to find and display your extension in the store. It can be changed at any time in your extension details.
How can I change the style of my extension description text?
In the product and profile descriptions, the following HTML tags can be used in your extension description:
<a> <b> <i> <em> <strong> <ul> <ol> <li> <p> <br> <h2> <h3> <h4>
You can also upload up to two YouTube videos and add links to documentation, sample shops, or other websites in your extension details.
What is the difference between highlights and features?
You can define up to 5 highlights and up to 15 features for your extension.
Highlights can be used to emphasize certain extension areas. Features allow you to provide a nice overview of the extension functionalities.
How can my keywords be found?
The keywords help search for your extension. Think about what terms the customers can use to search for your extension solution and include them as keywords in your extension details.
How many keywords can I define for my extension?
You can define up to 5 keywords in your extension details.
Can I upload a video that is not on YouTube?
No, the videos have to be uploaded from YouTube.
Is there a maximum file upload size for images?
Yes, this is 1 MB. If your picture is too big, you will also receive a message in your account.
How can I remove or add images for a language?
If you have already uploaded an image, you can define the activation and the thumbnail for German and English by clicking on the three dots on the bottom right under Description & Images > Images in your extension details.
How can I delete an image from my extension details?
An image uploaded to your extension details under Description & Images > Images can be deleted by clicking on the three dots in the upper right corner of the selected image.
How can I add images or icons to my extension?
You can find detailed instructions for this in our how-to article.
Categorization
How can I assign a category to my extension?
Categories can be defined under Categorization in your extension details.
How many categories can an extension be assigned to?
An extension can be assigned to a maximum of one category.
Sales options
What options can I offer?
In the Shopware Store, extensions can be offered free of charge or for monthly rental. If monthly rental is offered, annual rental can also be offered.
What happens if I still have customers with the purchase subscription?
All customers who still have a purchase subscription for an extension can switch to the rental version via their account. They will receive a fixed upgrade discount.
Marketing
Where can I find marketing options for my extension?
Available marketing options can be found in the “Marketing” section in the extension details:
Shopware extension certification (Bronze, Silver, and Gold awards)
Special highlighting in the list (upon activation, your extension will be displayed under “Recommendations” in the assigned category)
In addition, you can create marketing options for your extension, such as bundles, discount promotions, and vouchers, in the same areas in the account.
Marketing options that are not available through the account:
→ If you are interested in these two other options for your extension to get even more visibility in the store, please feel free to email your extension proposal to alliances@shopware.com
What happens when you click on the “Individual minimal Shopware version” button?
This option allows you to control the compatibility with Shopware versions in the Shopware Store. All Shopware versions below the one you select will no longer be displayed on the extension details page under “Compatible with”. In addition, this will be taken into account when filtering in categories.
Extension versions
How can I upload a new extension version?
You can upload a new version of your extension, e.g., when you have created a new update, in your app details in the “Versions” section.
Extension update: When should I update my app and create a new version for it?
We recommend that you upload a new extension version if your extension has a new feature. The customer will get an update option displayed in the backend and will see directly that there was a change in the extension.
If your extension has not yet been enabled for the store, or if there is a critical bug in the extension, you can update it directly in an extension version.
What should I do if I detect a security gap in my extension?
For new updates, you can recall a version within three days after uploading it. You can also introduce a fix with a completely new version.
Demo shops
Why should I define a demo shop for my extension?
A demo shop lets the customer test or see your extension in a “live” environment, allowing you to highlight your extension's functionality even more.