Plentymarkets Plugin Setup
In just a few steps we will explain how to install and set up the plentymarkets 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 plentymarkets 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 plentymarkets 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 
.
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. |
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. Table 2 explains which texts are displayed in which widget:
Field | Explanation |
Points Label | The desired name of the points. The template variable [points_label] outputs the name selected here at any text positions. |
Widget Border Width | The desired border width of the widgets in px. If no frame should be displayed, enter the value 0px. |
Widget Border Color | The desired border colour of the widgets as a hexadecimal colour code. |
Checkout/Shopping Cart Widget Heading | The desired heading for the Checkout/Shopping Cart widget. |
Checkout/Shopping Cart Widget Text for unregistered users | The desired text message, which is displayed in the Checkout/Shopping Cart widget to users who have not yet participated in the loyalty program or who are not logged in. |
Checkout/Shopping Cart Widget Text for registered users | The desired text message that will be displayed in the checkout widget for users participating in the loyalty program. |
Checkout/Shopping Cart Widget Text for no redemption | The desired text for the Checkout/Shopping Cart widget, which is associated with the radio button with the "continue collecting/no redemption" function. |
Checkout/Shopping Cart Widget Text for full redemption | The desired text for the Checkout/Shopping Cart widget, which is associated with the radio button with the "full redemption" function. |
Checkout/Shopping Cart Widget Text for partial redemption | The desired text note for the Checkout/Shopping Cart widget, which is assigned to the radio button and the input field with the "partially redemption" function. |
MyAccount Widget Heading | The desired heading for the MyAccount Widget. |
MyAccount Widget Text for unregistered users | The desired text hint for the MyAccount widget, which is displayed to users not yet participating in the loyalty program or not logged in to the shop. |
MyAccount Widget Text to end the participation | The desired text note for the MyAccount widget, which is assigned to the checkbox and the "Delete" button. |
MyAccount Widget Text for redeemable points | The desired text for the first line in the MyAccount widget. The account balance of redeemable points is displayed here by default. |
MyAccount Widget Text for locked points | The desired text for the second line in the MyAccount widget. The account balance of the locked points will be displayed here by default. |
MyAccount Widget Text for expiring points | The desired text for the third line in the MyAccount widget. The number of points that will expire in the next 30 days is displayed here by default. |
MyAccount Widget Text for merging accounts | The desired text for the MyAccount widget, which is assigned to the input field and the "Merge" button. |
Product Widget Heading | The desired heading for the Product Widget. |
Product Widget Text for unregistered users | The desired text hint for the product widget, which is displayed to users who are not participating in the loyalty program or not logged in to the shop. |
Product Widget Text for registered users | The desired text that will be displayed in the Product Widget for users participating in the loyalty program. |
Product Widget Text for registered users for extra points | The desired text that will be displayed in the Product Widget for Extra Points for users participating in the loyalty program. This text is attached to the Product Widget text for registered users. |
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 3 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. |
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 4. When you have entered your settings, click on save :
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. |
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 plentymarkets 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 plentymarkets 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. |
Link widget container
With the help of the container links you can place the widgets provided by Loyalista in your plentyShop. To do this, click on Container Links in the left menu selection within the plugin settings (picture 4). For the widgets "Checkout/Shopping cart Widget" and "Product Widget" you will find our suggested standard container links. All you need to do here is select the suggestions and save the setting . If you want to link the widgets to other containers, you can find the widgets under the item Container Links >> Data Provider and assign the shop placements according to Table 5. Click on Save Container Link after each widget:
| Widgets | Container |
MyAccount Widget | The plugin creates a separate page for this widget, as it cannot currently be displayed on the My Account page with the standard containers. For more information, see the following paragraph. |
Checkout/Shopping cart Widget | Default container links: BasketTotals.AfterTotalSum Alternative: Any container for Checkout and any container for Shopping cart |
Product Widget | Default container links: SingleItem.BeforeAddToBasket Alternative: Any container for SingleItem |
For more information on linking containers, please refer to the plentymarkets manual.
As already described, the MyAccount widget does not require a container link, as the plugin creates a separate page for the widget. You can check this in plentymarkets under CMS >> ShopBuilder. The plugin should have created a new page called Bonusprogramm. This page cannot be changed via the ShopBuilder. It simply displays the MyAccount widget in your shop, using your header and footer. However, this page still has to be linked in your shop at any place so that your customers can find it. We recommend creating this link on the My Account page of your shop:
To do this, open the MyAccount page in your ShopBuilder (picture 5).
On the left side you will find different menus to place widgets on the page. Click on More Widgets to display the other widgets. Here you should find the Loyalista - MyAccount widget (picture 6). This is not the MyAccount Widget, but a button or link that leads to this widget/page. Drag the widget anywhere on your My Account page.
By clicking on the cogwheel inside the widget, you can enter a title for the button/link on the right-hand side of the ShopBuilder and select whether it should be displayed as a button or a link (picture 7).
For more information on working with the ShopBuilder, please refer to the plentymarkets manual.
Create events
Orders and credit notes are exported to Loyalista via events in plentymarkets. 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 plentymarkets system. >> Orders >> Events. Use the + symbol to add an event action (picture 9).
Table 6 gives you an example of an event for orders and Table 7 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 |
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 |
For more information on creating events, please refer to the plentymarkets manual.
Related Articles
Further Explanations
In this article you will find some important explanations about the plentymarkets 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 " Revenue ...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 plentymarkets plugin. Das Plugin bietet dir allerdings auch die Möglichkeit Aufträge und ...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. ...