Plugins

Version

2.0.0 or newer

Table of contents

Overview

What are Shopware 6 plugins?

Shopware 6 plugins are plugins specially designed for Shopware 6 and developed by you. They are also displayed in the store directly under the Shopware 6 category.

What are Shopware 5 plugins?

Shopware 5 plugins are plugins and themes specially developed for Shopware 5, which are also displayed in the store as Shopware 5 plugins.

What is a successor plugin?

Successor plugins are Shopware 6 plugins that continue the functionality/features of your existing Shopware 5 plugins 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 plugins?

Since Shopware 6 relies on a completely new technical basis, a Shopware 6 plugin is a completely separate product in the Community Store. This means that updating a plugin from version 5 to version 6 is impossible.

What do the statuses mean in my plugin overview?

Incomplete
Your plugin details are not complete. Click on “Details” to get to the plugin 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 plugin. You can do this under “Versions” as soon as you have filled in all plugin details.

Code review failed
Your plugin failed the automated code review. The version of your plugin contains technical feedback on what has failed. You can also upload a new version and restart the code review.

Pending approval
Your plugin has passed the automated code review and is waiting to be tested manually by Shopware.

Rejected
Your plugin was rejected by Shopware. For questions, please send an email to plugin-manufacturer@shopware.com.

Approved
Your plugin has been reviewed and approved by Shopware. You can now enable it for the store in the master data under “Publish plugins”.

In store
Your plugin has already been approved and is available in the Community Store.

Deleted
You have deleted the plugin.

How can I create a new plugin?

Once you have accepted the manufacturer contract, and this has also been accepted by Shopware, you will be able to use the manufacturer section in the account.
Go to “Plugins” > “Create new plugin” to get to the plugin details where you can upload your plugin and update the information about it.

What is the status overview in my plugin details?

Your plugin status overview contains important information about your plugin life cycle and “errors”.
The Life cycle shows the current status of your plugin. You will see different messages in the info box:
“Errors found” shows which fields have not yet been completed.

Your plugin was denied. Why can this be?

The life cycle shows the current status of your plugin. The “Errors” info box contains various messages about what is missing in the plugin details. In addition, there are several reasons why a plugin has not yet made it into our store. Besides an inadequate code quality according to our Quality Guide → https://docs.shopware.com/en/plugin-standard-for-community-store 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. plugin-manufacturer@shopware.com

What to consider when cancelling a plugin 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 plugin manufacturer and Shopware see the cancelled plugin version

What is the plugin 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 plugin certified?

Your plugin will automatically be checked for the next highest certification level. You can see the available certification level directly in your plugin details at the top under “Plugin certification”.
If your plugin has reached a certification level, you can go to “Marketing” in your plugin details to have your certification displayed and draw more attention to your plugin in the store.

Which plugin certifications are there?

Your plugin can have the Bronze, Silver or Gold certifications. Information on the respective seals can be found here.

Why does the plugin certification cost money?

The plugin certification is a separate and detailed review of your plugin by Shopware, which is listed separately with a badge. Excellent plugins get a much higher visibility in the store.

Where can I see which certification level my plugin has reached?

Look for “Plugin certification” in the second section of your plugin 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.

When does my plugin require a Shopware technology agreement?

If your plugin 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 plugins.
We will be happy to help you with this! If you have any questions about the technology partner agreement, please contact our Sales Team at: sales@shopware.com or Tel.: +49 (0) 25 55 / 928 85-0 

Do I need an SDK licence for plugin development?

You need an SDK licence if you develop extensions with backend components for Shopware 5 and want to offer them under a proprietary licence (i.e. extensions that are not licensed under the GNU Affero General Public Licence Version 3 or a compatible licence). These can be purchased directly through us → https://store.shopware.com/en/swag187921076273/shopware-5.0-sdk-licence.html

Plugin details 

What are the master data?

The plugin master data contains all the basic data for your plugin:

  • Activating and publishing your plugin in the Community Store

  • Presenting your technical plugin name
  • Default language: which language is the default one in your plugin
  • Plugin availability: here, you can decide whether the plugin should be available in the German store and/or international stores.
  • Creation date: when was your plugin created?
  • Plugin item number
Licence: which licensing model your plugin has (proprietary, MIT, LGPL, GPL v2, GPL v3, New BSD)
 

What is a technical plugin name?

The technical plugin name is the name used in your plugin. It always starts with the manufacturer prefix and can’t be changed after the plugin has been published, as it has an effect on your customers’ licensing.

Can I change the technical plugin name?

Since the technical plugin name has an effect on your customers’ licensing, it can’t be changed later.

Why is there a plugin item number in addition to the technical name?

The plugin item number is automatically assigned by Shopware to clearly identify the plugins in the store. After a plugin is deleted, the item number can’t be reassigned, as opposed to the technical name.

How can I display in the store that my plugin has also been translated into other languages?

The languages can be entered in your plugin details under “Description & images”. They show the customers in which languages your plugin is translated and are also displayed in the store under your plugin details.
  • German
  • English
  • Spanish
  • Finnish
  • French
  • Italian
  • Norwegian
  • Dutch
  • Polish
  • Swedish
  • Bulgarian
  • Czech
  • Portuguese
  • Armenian
  • German (Switzerland)
  • Turkish
  • How can I activate my plugin in the international store?

    Simply click on “Available in international store” button in your plugin details under “Master data” in your account. After saving, your plugin will also be displayed in the international store.
     
  • When will my plugin be approved?

    In order for your plugin to be approved, it has to 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 plugin.
    If you have any questions about 1–3, please email us directly at plugin-manufacturer@shopware.com.
    If you have any questions about 4–5, please email us directly at sales@shopware.com

What is the automated code review?

The code for your plugin 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 plugin 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 plugins are compatible with the latest Shopware minor version?

To do this, use the “Compatibility Wizard” in your plugin details. It can be enabled by clicking on the “Individual minimal Shopware version” button in the “Marketing” section.

Do I have to manually modify my plugins’ compatibility with each update?

No, you can enable the Compatibility Wizard to do this:
Just click on “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 plugin 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 plugin appear? Can I change it at any time?

The display name is used to find and display your plugin in the store. It can be changed at any time in your plugin details.

How can I change the style of my plugin description text?

In the product and profile descriptions, the following HTML tags can be used in your plugin description:
<a> <b> <i> <em> <strong> <ul> <ol> <li> <p> <br> <h2> <h3> <h4>
You can also upload up to two YouTube videos and, of course, add links to documentation, sample shops or other websites in your plugin details.

What is the difference between highlights and features?

You can define up to 5 highlights and up to 15 features for your plugin.
Highlights can be used to emphasize certain plugin areas. Features allow you to provide a nice overview of the plugin functionalities.

How can my keywords be found?

The keywords help search for your plugin. Think about what terms the customers can use to search for your plugin solution and include them as keywords in your plugin details.

How many keywords can I define for my plugin?

You can define up to 5 keywords in your plugin 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 plugin details.

How can I delete an image from my plugin details?

An image uploaded to your plugin details under “Description & Images” > “Images” can be deleted by clicking on the three dots in the upper right corner of the selected image.

Categorization

How can I assign a category to my plugin?

Categories can be defined under “Categorization” in your plugin details.

How many categories can a plugin be assigned to?

A plugin can be assigned to two categories at the most.

What are shopping world templates?

Shopping world templates can be created for the Shopware “Shopping worlds” feature and made available to the customer. If your plugin contains shopping world templates, you can activate the button for the plugin to be displayed separately in the store.

Sales options

What is behind the plugin subscription, and what does that mean for me?

By offering the plugin subscription, you agree to provide updates and support. After 12 months, the customer can renew the subscription for 6, 12 or 24 months so that your further development and support efforts are, of course, financially supported.

What happens if I no longer want to offer subscriptions for a plugin?

If you decide to no longer offer subscriptions for a plugin, the customers can easily change the plugin to “Lifetime” via the account.

How can I remove the subscription from my plugin?

If your plugin has a retail price below € 99.00, you can disable the subscription under “Sales option” in your plugin details. You are required to offer a subscription if your plugin costs more than € 99.00.

Marketing

Where can I find marketing options for my plugin?

Available marketing options can be found in the “Marketing” section in the plugin details:
  • Shopware plugin certification (Bronze, Silver and Gold awards)
  • Special highlighting in the list (upon activation, your plugin will be displayed under “Recommendations” in the assigned category)
In addition, you can create marketing options for your plugins, such as bundles, discount promotions and vouchers, in the same areas in the account.
Marketing options that are not available through the account:
  • Nomination as “Plugin of the week”
  • Nomination as “Plugin of the month”
→ If you are interested in these two other options for your plugin to get even more visibility in the store, please feel free to email your plugin proposal to plugin-manufacturer@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 Community Store. All Shopware versions below the one you select will no longer be displayed on the plugin details page under “Compatible with”. In addition, this will be taken into account when filtering in categories.

Plugin versions

How can I upload a new plugin version?

You can upload a new version of your plugin, e.g. when you have created a new update, in your plugin details in the “Versions” section.

Plugin update: When should I update my plugin, and when should I create a new version for it?

We recommend that you upload a new plugin version if your plugin 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 plugin.
If your plugin has not yet been enabled for the store, or if there is a critical bug in the plugin, you can update it directly in a plugin version.

What should I do if I detect a security gap in my plugin?

For new updates, you can recall a version within 3 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 plugin?

A demo shop lets the customer test or see your plugin in a “live” environment, allowing you to highlight your plugin’s functionality even more.
































 

Was this article helpful?