Is this article helpful?
 
(optional) let us know why:

Offering services

plentymarkets uses plugins not only to extend the functionality of your webstore and back end, but also to offer other services on plentyMarketplace like support or setup help. This tutorial shows how to offer such a service.

Further reading

We have prepared a template for you to use. Download it below.

Folder structure

First, you need to create the folder structure for your plugin. If you downloaded the template provided above, you can get proceed to the next step right away.

HelloServiceWorld/
    ├── meta/
    │   ├── images/
    │   │   │   // preview images showing this plugin
    │   │   ├── preview_[0-6].[png │ jpeg]
    │   │   │   // plugin icons
    │   │   ├── icon_plugin_[xs │ sm │ md].[png │ jpeg]
    │   │   │   // authors logo
    │   │   └── icon_author_[xs │ sm │ md].[png │ jpeg]
    │   └── documents/
    │       ├── user_guide_en.md // English user guide for the plugin
    |       └── user_guide_de.md // German user guide for the plugin
    │
    ├── marketplace.json //marketplace information
    │
    └── plugin.json // plugin information

Even if you have never developed a plugin before, you are probably familiar with most of these types of files. However, we will also discuss the specifics below.

Step 1: Adding images

In the meta/images/ folder, you must add three kinds of images. They will be displayed in various places on plentyMarketplace.

There is the plugin icon and your logo, both in three different sizes, as well as up to seven preview images. If you downloaded the HelloServiceWorld template, replace the images included in the folder with your own. There are size restrictions for the icons and logos. Check the table below for details. Finally, no matter whether you include seven preview images or only one, the total size of these files must not exceed 1 MB.

Name Size
_xs 32x32 px
_sm 256x256 px
_md 512x512 px

If you plan on offering the same service in multiple variations, e.g. consulting for one hour and consulting for five hours, it makes sense to indicate this in the plugin icon and preview images in some way. Note that you must create a new service plugin for each variation.

Step 2: Writing descriptions

In the meta/documents/ folder, you must create user guides in German and English. These will be shown as descriptions in the detail view of your service on plentyMarketplace. If you downloaded the HelloServiceWorld template, you can just modify the existing files.

Step 3: Creating the plugin.json

The plugin.json file contains some general metadata of your plugin.

HelloServiceWorld/plugin.json
{
    "name"              : "Service",
    "namespace"         : "HelloServiceWorld",
    "type"              : "service",
    "version"           : "1.0.0",
    "webhookUrl"        : "DOMAIN/service/tickets"
    "pluginIcon"        : "icon_plugin_xs",
    "description"       : "The description for your plugin",
    "author"            : "Your name",
    "authorIcon"        : "icon_author_xs"
}

Webhook

When customers purchase your service, plentyMarketplace will generate a JSON file with the customer's data and send it to you through a webhook. You will use this information to contact the customer. If you have your own server, you can use it to receive the JSON file by entering the payload URL as webhook URL in the plugin.json file. Alternatively, you can use an external service, or use one of our plugins and receive customer data as tickets in your plentymarkets system. If you want to use the plugin solution, install this plugin from plentyMarketplace.

Follow the instructions here to add the plugin to your system. Afterwards, install the plugin in any plugin set and build the set. Open the configuration by clicking on the plugin's name in the Plugin Overview.

Create a new role, type and status in the ticket system and enter the respective IDs in the Ticket tab. In the same tab, enter the IDs of the users that are allowed to see the tickets with your customers' data. You can find them in the System » Settings » User » Accounts menu by clicking on the name of a user.

Do not change the path in the Webhook URL tab. In your service plugin's plugin.json file, replace DOMAIN with the domain of your plentymarkets system.

Step 4: Creating the marketplace.json

The marketplace.json file contains metadata relevant only for plentyMarketplace.

HelloServiceWorld/plugin.json
{
    "marketplaceName"   : {"de":"German display name of plugin","en":"English display name of plugin"},
    "price"             : 10.00,
    "shortDescription"  : {"de":"German short description","en":"English short description"},
    "categories"        : ["3888"],
    "keywords"          : ["keyword 1", "keyword 2"]
}

Uploading the service

In order to upload your service to plentyMarketplace, you must first add your new service plugin to your own plentymarkets system. You can use Git for this, following the instructions here. Afterwards, install the plugin in any plugin set and build the set, then proceed as follows:

  1. Open the plentymarkets back end.
  2. Go to Plugins » Plugin overview.
  3. Click on the plugin that you want to upload to plentyMarketplace.
    → A new tab will open.
  4. Check the plugin information, i.e. description, images, change log and configuration.
  5. Click on Marketplace upload.
    → The Marketplace upload window will open.
  6. Click on Upload.
    → The plugin will be uploaded to plentyMarketplace.
  7. The plugin requires a review by plentymarkets.
    → The plugin will be made available on plentyMarketplace after the review.

Before going live, the plugin needs to be reviewed by plentymarkets staff. Log in to plentyMarketplace and go to the My Partner portal page to check the review status of your plugin.