Plentymarkets Plugin Setup

Plentymarkets Plugin Setup

In just a few steps we will explain how to install and set up the PlentyONE integration of Loyalista. The integration allows you to integrate the Loyalista functionalities into your plentyShop and thus bind your customers to you in the long term.

After you have successfully set up your plugin, take a look at the Further Explanations and the Best Practices so that you fully understand the functionalities.

Install and deploy Loyalista plugin

Search for Loyalista in plentyMarketplace and buy the free plugin.

You can then add the plugin to your current plugin set in your PlentyONE system by clicking on Plugins >> Plugin set overview on the Plugin Set, which you want to edit. Then click on Add Plugin in the menu on the left and select Loyalista from the list. Now you can install the Loyalista plugin by clicking on Install. After successful installation, the plugin set is displayed again. Activate the Loyalista plugin with the slider and select Deploy plugin set.

For more information on installing and deploying plugins, please refer to the PlentyONE manual.

Set up plugin connection

Click on the Loyalista plugin within the plugin set in which you have installed and deployed Loyalista. The plugin connection settings open (Picture 1). Adjust the settings according to Table 1. Then click on save .

Picture 1

Settings
Explanation
Plenty ID
Add your Plenty ID.
Vendor ID
Log in to the Loyalista website. You can find the Vendor ID in the left main menu under Integrations.
Vendor HASH
Log in to the Loyalista website. You can find the Vendor Hash in the left main menu under Integrations.
User Secret / API Access Token
Log in to the Loyalista website. You can find the User Secret in the left main menu under Integrations.
Table 1

Edit plugin content

Open Loyalista's content settings by clicking on Content within the plugin (Picture 2). Here you will find predefined texts and settings, which will be displayed in certain places within the widgets in your plentyShop. The predefined texts and settings are only suggestions and are intended to make it easier for you to get started with Loyalista. Of course, you can also customise them. One field is for the German text and one field for the English text. The texts can be adjusted as desired, click on save after adjusting. Tables 2 to 5 explain which texts are displayed in which widget:

Picture 2

Widget Content (General)

In Table 2 you will find all available settings and their description for the area Widget Content (General):

Field
Explanation
Name of points
Enter the name for your points here (e.g. points, hearts, coins).
Border width of all widgets
Enter the width of the border here in pixels (px) (default is 1). If the field is left empty, the CSS of the page or theme is used. If a value is entered, the CSS of the page or theme is overridden.
Border color of all widgets
Enter the color of the border here as a hex code (e.g. #000000). If the field is left empty, the CSS of the page or theme is used. If a value is entered, the CSS of the page or theme is overridden.
Table 2

Widget Content (Checkout Widget)

In Table 3 you will find all available settings and their description for the area Widget Content (Checkout Widget):

Field
Explanation
Heading
Enter the heading for the Checkout/Shopping cart widget here.
Text hint for unregistered users
Enter the text here that will be displayed to users who are not logged in. Available variable: [points_for_signup].
Text hint for registered users
Enter the text here that will be displayed to users who are logged in. Available variable: [account_balance].
Text hint for no point redemption
Enter the text here that is displayed when no points have been selected for redemption.
Text hint for full point redemption
Enter the text here that is displayed when all available points have been selected for redemption.
Text hint for partial point redemption
Enter the text here that is displayed when only some of the points have been selected for redemption. Available variable: [redeemed_points].
Table 3

Widget Content (MyAccount Widget)

In Table 4 you will find all available settings and their description for the area Widget Content (MyAccount Widget):

Field
Explanation
Heading
Enter the heading for the MyAccount widget here.
Text hint for unregistered users
Enter the text here that will be displayed to users who are not logged in. Available variable: [points_for_signup].
Text hint for ending participation
Enter the text here that is displayed below the button to end participation.
Text hint for redeemable points
Enter the text here that will be displayed for the redeemable points. Available variable: [account_balance].
Text hint for locked points
Enter the text here that will be displayed for the currently locked points. Available variable: [locked_balance].
Text hint for expiring points
Enter the text here that will be displayed for the points that will expire soon. Available variable: [expiring_points], [expiry_date].
Text hint for merging accounts
Enter the text here that will be displayed to users when there is a possibility of merging accounts.
Text hint for points for birthday
Enter the text here that will be displayed as a hint for the points for the birthday. Available variable: [points_for_birthday].
Table 4

Widget Content (Product Widget)

In Table 5 you will find all available settings and their description for the area Widget Content (Product Widget):

Field
Explanation
Heading
Enter the heading for the Product widget here.
Text hint for unregistered users
Enter the text here that will display the points for this product to unregistered users. Available variable: [points_per_product].
Text hint for registered users
Enter the text here that will display the points for this product to registered users. Available variable: [points_per_product].
Text hint for extra points for registered users
Enter the text here that will show the extra points for this product to users if any have been defined in Loyalista for the product or category. Available variable: [extra_points].
Table 5

Within the content fields, certain template variables can be used. Template variables are placeholders that are automatically replaced by the plugin with certain terms or values. In Table 6 you will find a list of the available template variables.

Template-Variable
Explanations
[points_label]
Outputs the name of the points.
[points_for_signup]
Outputs the number of points that users receive for registering for the loyalty program.
[number_of_points_shopping_cart]
Outputs the number of points that will be credited to the current shopping basket in the event of a purchase.
[account_balance]
Outputs the number of redeemable points.
[value_of_account_balance]
Outputs the value in € of the redeemable points.
[date_of_expiry]
Currently outputs the value 30. This is the period in days that is used as the basis for the template variable [amount_of_points].
[amount_of_points]
Outputs the number of points that will expire in the next [date_of_expiry] days.
[number_of_points]
Outputs the number of standard points that will be credited for an item of the current product.
[points_for_product]
Outputs the number of standard points that will be credited for an item of the current product.
[number_of_extra_points]
Outputs the number of extra points that will be credited for an item of the current product.
[extra_points]
Outputs the number of extra points that will be credited for an item of the current product.
[locked_balance]
Outputs the number of currently locked points.
[expiring_points]
Outputs the number of points that will expire soon.
[expiry_date]
Outputs the date on which points will expire.
[redeemed_points]
Outputs the number of points that have been redeemed.
[points_for_birthday]
Outputs the number of points that users receive for their birthday.
[total_number_of_redeemable_points]
Outputs the number of currently redeemable points.
[total_number_of_locked_points]
Outputs the number of currently locked points.
Table 6

Customise loyalty program settings

Open the Loyalista settings for the loyalty program by clicking on Settings within the plugin (Picture 3). Here you can further individualise your loyalty program by making the settings according to Table 7. When you have entered your settings, click on save :

Picture 3

Configure your bonus settings in this area according to Table 7:

Setting
Explanation
Revenue for One Point
Enter the revenue in the default currency that a customer must generate to earn one point.
Value of One Point
Enter the value in the default currency that one point has.
Locking time of the points
Enter the time in days that must pass before points can be redeemed after completing the pur
Durability of the points
Enter the time in days that points are redeemable after the locking period. If this field is empty, points have no expiry date.
Points for Signup to the loyalty program
Enter the number of points customers receive when they sign up for your loyalty program.
Birthday points
Enter the number of points that customers receive for their birthday.
Threshold for expiring points
Enter the period in days from when customers should be shown a warning for expiring points in their customer account. Default value is 30 days.
Basis points per order
Enter the number of points customers receive when they make a purchase from your shop (will be added to the points according to revenue).
Extra Points for Category
Enter the number of points customers receive when they purchase an item of a product from a category with Extra Points.
Category IDs with Extra Points (comma separated)
Enter the PlentyONE category IDs (comma-separated if more than one ID is entered) for whose contained products extra points are granted.
Extra Points for Variants
Enter the number of points customers receive when they purchase an item of a product with Extra Points.
Variation IDs (comma separated)
Enter the PlentyONE variant IDs (comma-separated if more than one ID is entered) for whose contained products extra points are granted.
Checkbox Allow partial redemption?
When activated, the partial redemption radio box appears in the checkout widget and users have the option to choose the number of points to redeem.
Table 7

Info
The settings made here are exported to your Loyalista backend. It is not possible to adjust the settings within your Loyalista account. The export takes up to 30 minutes.

Warning
It can take up to 60 minutes for the settings to be adjusted. The last synchronization of the plugin with the Loyalista account is displayed as a timestamp on the Main menu: Integrations page in Loyalista.

Coupons

Discounts for point redemptions are realized through coupons. In order for the plugin to automatically create voucher codes in PlentyONE (and delete them if they are not redeemed), a corresponding voucher campaign must be set up. This campaign serves as a template for all vouchers that customers receive by redeeming points. To do this, go to Orders >> Coupons in PlentyONE and create a new campaign. Then configure the settings in the Settings tab according to Table 8. Further information on setting up voucher campaigns can be found in the PlentyONE manual.

Setting
Recommended value
Name
Any, e.g. Loyalista Coupons
Description
Any
Concept
Several codes, one single redemption
Usage
Single order only
Minimum order value
0.00
Start date
Today's date
End date
Leave empty
Code validity in weeks
Leave empty
Voucher type
Voucher
Coupon type
Action voucher
Code length
16 characters
Discount type
Fixed amount
Discount value
1.00
Table 8

Place widgets via ShopBuilder

The widgets are set up via the ShopBuilder of your plentyShop. With the help of the ShopBuilder, you have the possibility to place the three Loyalista widgets (My Account, Product and Checkout) at any position in your shop. "Any position" in this sense means that you can freely choose where the widget should appear within the corresponding page (My Account, Product View or Checkout). Please note that the widgets must logically be placed on the appropriate pages in order to function correctly.

MyAccount Widget

The MyAccount widget gives your customers some information about their participation in your loyalty program. If the customer has not yet registered for your loyalty program, this widget gives them the opportunity to do so. Once they have registered, the customer will see the information and can perform the actions shown in Table 9.

Information/Action
Description
Redeemable points
Shows the number of points currently available for redemption.
Locked points
Shows points that are not yet redeemable (e.g., due to the cancellation period of orders).
Points expiring in the next X days
Informs about how many points will expire within the configured period (e.g., 30 days).
Set up date of birth
Allows the customer to enter their date of birth to receive annual bonus points.
Merging two accounts
Allows transferring points from a guest account or a second account to the current account.
End participation in loyalty program
Provides the option to cancel participation in the loyalty program.
Table 9

You can place the widget on the My Account page of your shop by opening the ShopBuilder via Shop in PlentyONE and selecting the category with your My Account page. Then select your active page under Content on the right side (Picture 4). The ShopBuilder opens (Picture 5).

Picture 4
If you open the More widgets option in the left menu, you will find the three Loyalista widgets. Drag the widget Loyalista - MyAccount Widget to the desired position on your page. Save your choice by clicking on .

Picture 5

Product Widget

The product widget is placed on the product page of your shop. Depending on whether a customer is registered for your loyalty program (or has logged in to your shop) or not, they receive different information via this widget. For unknown customers, your loyalty program is advertised via the widget. For logged-in customers who participate in the loyalty program, the widget displays the number of points the customer would receive when purchasing a product of this type. Possible extra points for special variants or categories are also shown in the widget. The widget is placed on the page via the ShopBuilder in the same way as the MyAccount widget. Take a look at Pictures 6 and 7 for more information.

Picture 6

Picture 7

Checkout Widget

The Checkout widget allows your point-collecting customers to redeem their points. To do this, they select one of the following three points at the checkout within the widget: Continue collecting, Partial redemption or Full redemption. With Continue collecting, the points from the current purchase are simply credited to them. With Partial redemption, the customer can enter the desired number of points they would like to redeem in an input field. The customer must then click on the Apply button. This creates a voucher code that directly applies the corresponding discount for the redemption. With Full redemption, the customer can click directly on the Apply button and a voucher code for the full value of the points will be created and applied directly. The customer then only needs to complete their purchase. The checkout widget is also placed in the same way as the MyAccount widget, see Pictures 8 and 9.

Picture 8

Picture 9

Further information on how the widgets or the loyalty program works can be found in our manual Further Information and all the information you need on working with the ShopBuilder can be found in the PlentyONE manual.

Create events

Orders and credit notes are exported to Loyalista via events in PlentyONE. Orders and credit notes must be exported to Loyalista so that the points can be credited or deducted correctly. If there are to be different triggers for exporting an order, you can create as many event actions for it as you like. Even if events overlap and orders are thus exported more than once, Loyalista takes this into account and duplicate orders are discarded. Click on Setup in your PlentyONE system. >> Orders >> Events. Use the + symbol to add an event action (Picture 10).

Picture 10

Table 10 gives you an example of an event for orders and Table 11 gives you an example of an event for credit notes:

Settings
Value
Active
Activate
Name
Give the event action a unique name
Event
Payment >> Complete
Filter
Order >> Order type >> Order
Filter
Order >> Referrer >> Mandant (Shop)
Action
Plugins >> Loyalista: Send order to Loyalista
Table 10

Settings
Value
Active
Activate
Name
Give the event action a unique name
Event
Order generation >> New credit note
Filter
Order >> Order type >> Credit note
Filter
Order >> Referrer >> Mandant (Shop)
Action
Plugins >> Loyalista: Send credit to Loyalista
Table 11

For more information on creating events, please refer to the PlentyONE manual.



    • Related Articles

    • Further Explanations

      In this article you will find some important information about Loyalista, the PlentyONE plugin and the widgets it contains. You should have installed and set up the plugin before reading this article. General Regardless of the conversion rates " ...

    • Create Credit Note

      Loyalista processes credit notes like orders, but (described in simplified terms) the signs are reversed. This means that points credits are deducted again and points redemptions are credited again. To do this, credit notes must be sent to Loyalista. ...

    • How to Send Order/Credit Notes Manually to Loyalista

      Orders and credit notes should generally be sent to Loyalista via the corresponding events. You can find more information in our manual for setting up the PlentyONE plugin. However, the plugin also offers you the option to manually send orders and ...