Offering services and tools

In addition to plugins, you can also offer services and tools on plentyMarketplace.

  • Services provide advice and assistance for plentymarkets, for example setting up an online store or integrating a marketplace. Services may be provided for a particular project or a fixed period of time.

  • Tools are software that provides functionality for a plentymarkets system without being deployed through the plugin structure. For example, plentyDevTool and plentyBase are both tools.

Select the type of product you want to offer:

  • Creating a service offer

  • Creating a tool offer

To create a new offer, proceed as follows:

  1. On plentyMarketplace, go to My account » My offers.

  2. Click on Create new offer.

  3. Fill out the form.
    After completing the form, your offer needs to be reviewed by plentysystems. You can check the status of the review in the My offers menu.

Whenever a customer purchases your service, customer information is sent to the address you provide in the Webhook URL field. The information is sent in a JSON file.

If you have your own server, you can use it to receive the file by entering the payload URL in the webhook field. If not, you can use an external service, or our Service Helper plugin and receive customer data as tickets in your plentymarkets system.

If you’re using the plugin solution, enter DOMAIN/service/tickets as webhook URL, where DOMAIN is the domain of your plentymarkets system.

Using the Service Helper plugin

To use the Service Helper plugin, you need to set up the ticket system and configure the plugin.

Setting up the ticket system

In the ticket system, create a new role, type, and status.

Configuring the plugin

After purchasing the Service Helper plugin, install it in your system.

Once you’ve installed the plugin, proceed as follows:

  1. Open the Settings of the Service Helper plugin.

  2. Open the Ticket menu.

  3. Enter the IDs of your newly created role, type, and status into the respective fields.

  4. Enter the IDs of the users that are allowed to see the tickets with your customers' data. You have to enter at least one ID.

    To determine a user ID, go to the Setup » Settings » User » Accounts menu and click on the name of the user.
    image::back-end-user-id.png[width=640, height=360]

Automation

After configuring the plugin, you can automate your processes. Automatically send emails when a new ticket is created to inform your customers about the next steps.

Customer information

Whenever a customer purchases your service, a JSON file is sent to your webhook URL. This file contains all the information necessary for you to contact the customer about their order. Below, you can find an example of the file, as well as descriptions of the individual fields.

{
    "id":"evt_553ea8a294e2d3a75d5086a06fb53f5a",
    "type":"SERVICE.PLUGIN.PURCHASE",
    "createdAt":1510656066,
    "resource":{
       "contact":{
          "id":1337,
          "gender":"male",
          "firstName":"John",
          "lastName":"Doe",
          "email":"john@account.com",
          "updatedAt":1510837206
       },
       "address":{
          "id":25,
          "companyName":"MyStore",
          "firstName":"John",
          "lastName":"Doe",
          "street":"Main Street",
          "houseNumber":"123",
          "additional":"",
          "postalCode":"34117",
          "town":"Kassel",
          "country":"DE",
          "phone":"123-456-7890",
          "email":"john@account.com",
          "updatedAt":1510753095
       },
       "order":{
          "id":221,
          "payPalTransactionId":"1S473067CV761473M",
          "orderItems":[
             {
                "itemVariationId":1338,
                "quantity":1,
                "orderItemName":"SuperService",
                "priceGross":49,
                "priceNet":41.1765
             }
          ]
       }
    }
 }

Each response contains the following information:

Field Type Description

id

string

The ID of the service. The ID consists of a maximum of 200 characters and is used for the communication between the plentymarkets API and the service partner API.

type

string

The type of the service is SERVICE.PLUGIN.PURCHASE.

createdAt

int

The timestamp of the service.

resource

Resource[]

The response resource containing information about the contact of the customer, the invoice address of the customer and the order, including the order items that are associated with the order.

The customer contact field contains the following information:

Field Type Description

id

int

The ID of the contact.

gender

string

The gender of the contact. The gender can be male, female or empty.

firstName

string

The first name of the contact.

lastName

string

The last name of the contact.

email

string

The private email address of the contact.

updatedAt

int

The timestamp when the contact was last updated.

The address field contains the following information:

Field Type Description

id

int

The ID of the address.

companyName

string

The company name.

firstName

string

The first name.

lastName

string

The last name.

street

string

The street.

houseNumber

string

The house number.

additional

string

Any additional address information.

postalCode

string

The postcode.

town

string

The town.

country

string

The ISO code of the country. For further information about country codes, refer to the list of Country IDs.

phone

string

The phone number.

email

string

The email address.

updatedAt

int

The timestamp when the address was last updated.

The order field contains the following information:

Field Type Description

id

int

The ID of the order.

payPalTransactionId

string

The ID of the PayPal transaction for this order.

orderItems

OrderItem[]

The order items that are associated with the order. Each order item has the following properties:

  • itemVariationId (int): The ID of the item variation.

  • quantity (float): The quantity of items ordered.

  • orderItemName (string): The name of the order item.

  • priceGross (float): The total gross price including surcharges and discounts. The gross price can have up to 4 decimal places.

  • priceNet (float): The total net price including surcharges and discounts. The net price can have up to 4 decimal places.

To create a new offer, proceed as follows:

  1. On plentyMarketplace, go to My account » My offers.

  2. Click on Create new offer.

  3. Fill out the form.
    After completing the form, your offer needs to be reviewed by plentysystems. You can check the status of the review in the My offers menu.

When offering a tool, you can provide the software either via direct download links or by forwarding customers to another site.