PlentyONE Plugin Setup

In just a few steps, we will explain how to install and configure the Loyalista PlentyONE integration. The integration allows you to add Loyalista features to your plentyShop and build long-term customer loyalty.

After successfully setting up your plugin, we recommend that you also take a look at our Further Explanations as well as the Best Practices.

Install and deploy the Loyalista plugin

In your PlentyONE system, navigate to Plugins >> plentyMarketplace. Search for the Loyalista plugin and purchase or install it free of charge.

Then add the plugin to the desired plugin set. To do so, open the plugin set you want to edit under Plugins >> Plugin set overview. Click Add plugin, select Loyalista from the list and install the plugin. Then activate the Loyalista plugin using the toggle and deploy the plugin set.

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

Set up the plugin connection

The connection between PlentyONE and Loyalista is established via OAuth2 using the PlentyONE assistant:

1. In your PlentyONE system, navigate to Setup >> Assistants >> Plugins.
2. Select the plugin set in which the Loyalista plugin is installed and deployed.
3. Select the Loyalista Integration plugin (Figure 1). The assistant opens.

4. In the assistant, click CONNECT TO LOYALISTA (Figure 2). You will be redirected for authorization. If you are not already logged in, log in to your Loyalista account and confirm the connection.
5. Once the connection has been established successfully, a confirmation message appears and you are automatically redirected back to the assistant.
6. Complete the assistant to finish setting up the connection.

Edit plugin content

Open the Loyalista content settings by clicking Content within the plugin (Figure 3). Here you will find predefined texts and configurations that are displayed at various places within the widgets in your plentyShop. The predefined texts and settings are suggestions intended to make it easier for you to get started with Loyalista.

Separate fields are available for the German and English versions of the texts. You can customize all texts individually. After making changes, click Save .

Table 1, Table 2, Table 3 and Table 4 explain the respective texts and widgets:

Widget content (General)

Field	Explanation
Points name	Enter the name you want to use for your points here (e.g. points, hearts, coins).
Border width of all widgets	Enter the width of the border in pixels (px) here (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 border color as a hexadecimal color code here (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.

Widget content (Checkout widget)

Field	Explanation
Heading	Enter the heading for the checkout/shopping cart widget here.
Text notice for unregistered users	Enter the text that is displayed to users who are not logged in. Available variable: [points_for_signup].
Text notice for registered users	Enter the text that is displayed to users who are logged in. Available variable: [account_balance].
Text notice when no points are redeemed	Enter the text that is displayed when no points have been selected for redemption.
Text notice when all points are redeemed	Enter the text that is displayed when all available points have been selected for redemption.
Text notice when points are partially redeemed	Enter the text that is displayed when only part of the available points has been selected for redemption. Available variable: [redeemed_points].

Widget content (MyAccount widget)

Field	Explanation
Heading	Enter the heading for the MyAccount widget here.
Text notice for unregistered users	Enter the text that is displayed to users who are not logged in. Available variable: [points_for_signup].
Text notice for ending participation	Enter the text that is displayed below the button for ending participation in the loyalty program.
Text notice for redeemable points	Enter the text that is displayed for redeemable points. Available variable: [account_balance].
Text notice for locked points	Enter the text that is displayed for points that are currently locked. Available variable: [locked_balance].
Text notice for expiring points	Enter the text that is displayed for points that will expire soon. Available variables: [expiring_points], [expiry_date].
Text notice for merging accounts	Enter the text that is displayed to users when they have the option to merge accounts.
Text notice for birthday points	Enter the text that is displayed as a notice regarding birthday points. Available variable: [points_for_birthday].

Widget content (Product widget)

Field	Explanation
Heading	Enter the heading for the Product widget here.
Text notice for unregistered users	Enter the text that displays the points available for this product to unregistered users. Available variable: [points_per_product].
Text notice for registered users	Enter the text that displays the points available for this product to registered users. Available variable: [points_per_product].
Text notice for extra points for registered users	Enter the text that displays the extra points available for this product if extra points have been defined in Loyalista for the product or category. Available variable: [extra_points].

Template variables

Certain template variables can be used within the content fields. Template variables are placeholders that are automatically replaced by the plugin with specific terms or values. The following table provides an overview of the available template variables.

Template variable	Explanation
[points_label]	Displays the name of the points.
[points_for_signup]	Displays the number of points users receive for joining the loyalty program.
[number_of_points_shopping_cart]	Displays the number of points that will be credited for the current shopping cart if the purchase is completed.
[account_balance]	Displays the number of redeemable points.
[value_of_account_balance]	Displays the monetary value in € of the redeemable points.
[date_of_expiry]	Currently returns the value 30. This is the number of days used as the period for the [amount_of_points] template variable.
[amount_of_points]	Displays the number of points that will expire within the next [date_of_expiry] days.
[number_of_points]	Displays the number of standard points credited for one unit of the current product.
[points_for_product]	Displays the number of standard points credited for one unit of the current product.
[number_of_extra_points]	Displays the number of extra points credited for one unit of the current product.
[points_for_birthday]	Displays the number of points users receive for their birthday.
[total_number_of_redeemable_points]	Displays the number of points that are currently redeemable.
[total_number_of_locked_points]	Displays the number of points that are currently locked.

Adjust loyalty program settings

Click Settings within the plugin (Figure 4). Here you can configure your loyalty program according to your requirements. Once you have entered your settings, click Save .

Setting	Explanation
Revenue per point	Enter the amount of revenue in the default currency that a customer must generate to receive one point.
Value of one point	Enter the value of one point in the default currency.
Points lock period	Enter the number of days that must pass after a purchase is completed before the points can be redeemed. If points should not have a lock period, enter 0.
Points validity period	Enter the number of days for which points can be redeemed after the lock period has ended. If this field is left empty, the points do not have an expiration date.
Points for joining the loyalty program	Enter the number of points customers receive when they join your loyalty program.
Base points per order	Enter the number of points customers receive when they make a purchase. These points are awarded in addition to the points calculated based on the order value.
Extra points for category	Enter the number of extra points customers receive when purchasing an item from a category for which extra points have been configured.
Category IDs with extra points (comma-separated)	Enter the PlentyONE IDs of the categories whose products should receive extra points. Separate multiple IDs with commas.
Extra points for variations	Enter the number of extra points customers receive when purchasing an item of a variation for which extra points have been configured.
Variation IDs (comma-separated)	Enter the PlentyONE variation IDs for which extra points should be awarded. Separate multiple IDs with commas.
Allow partial redemption?	If activated, the option for partial redemption appears in the Checkout widget and users can choose the number of points they want to redeem themselves.
Birthday points	Enter the number of points customers receive for their birthday.
Threshold for expiring points	Enter the number of days before expiration from which customers should see a warning about expiring points in their customer account. The default value is 30 days.
Campaign ID for coupons	Enter the ID of the promotional coupon campaign from PlentyONE. The plugin uses this campaign to automatically create coupon codes in PlentyONE when points are redeemed. For more information, see the Set up coupons section.

Set up coupons

Discounts resulting from point redemptions are implemented using coupons. In order for the plugin to automatically create coupon codes in PlentyONE and remove them again if a redemption is not completed, a corresponding coupon campaign must be configured. This campaign serves as a template for all coupons customers receive when redeeming points.

In PlentyONE, navigate to Orders >> Coupons and create a new campaign. Then configure the settings in the Settings tab as shown below. For more information about setting up coupon campaigns, refer to the PlentyONE manual on coupons.

Setting	Recommended value
Name	Any value, e.g. Loyalista Coupons
Description	Any value
Concept	Multiple codes, one 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
Coupon type	Coupon
Coupon variety	Promotional coupon
Code length	16 characters
Discount type	Fixed amount
Discount value	1.00

Place widgets using ShopBuilder

The widgets are configured using the PlentyONE ShopBuilder. You can place the three Loyalista widgets – MyAccount, Product and Checkout – at the desired positions on the corresponding pages of your plentyShop. For more information about ShopBuilder, refer to the PlentyONE ShopBuilder manual.

MyAccount widget

The MyAccount widget provides your customers with information and functions relating to their participation in your loyalty program. If a customer has not yet joined the loyalty program, they can use the widget to join it. Once they have joined, the following information and actions are available depending on your configuration:

Information/Action	Description
Redeemable points	Displays the number of points currently available for redemption.
Locked points	Displays points that cannot yet be redeemed, for example because of a configured lock period.
Points expiring within the next X days	Shows how many points will expire within the configured period, for example within the next 30 days.
Add date of birth	Allows customers to enter their date of birth in order to receive annual birthday points, provided that birthday points have been configured.
Merge two accounts	Allows points and the relevant loyalty program data from a guest account or secondary account to be merged with the customer's current account.
End participation in the loyalty program	Allows customers to end their participation in the loyalty program.

In ShopBuilder, select the category containing your My Account page (Figure 5). Open the active page in the editor (Figure 6). Drag the Loyalista – MyAccount Widget to the desired position and save your selection .

Product widget

The Product widget is placed on the item detail page of your shop. The information displayed depends on whether the visitor is logged in and participates in your loyalty program.

For visitors who do not yet participate in the loyalty program, the widget can be used to promote your loyalty program and show the points that can be earned for the respective product. Logged-in participants can see how many points they would receive when purchasing the product. If additional points have been configured for specific variations or categories, these extra points are also displayed separately in the widget.

Place the widget on your item view in ShopBuilder in the same way as the MyAccount widget (Figure 7 and Figure 8).

Checkout widget

The Checkout widget allows participants in your loyalty program to redeem their collected and currently redeemable points directly during the checkout process.

Depending on your configuration, customers can choose between Keep collecting, Partial redemption and Full redemption:

• Keep collecting: No existing points are redeemed. Once the purchase has been completed successfully, the customer receives the points awarded for the order.
• Partial redemption: The customer enters the number of points they would like to redeem and then clicks Apply. The plugin automatically creates a coupon code for the corresponding discount value and applies it to the order.
• Full redemption: The customer selects the full redemption of their available points and clicks Apply. The plugin creates a coupon code for the corresponding total value and applies it directly to the order.

Place the widget on your checkout page (Figure 9 and Figure 10).

For more information about how the widgets and loyalty program work, refer to our Further Explanations.

Set up automation using Plenty Flow Studio

To automatically transmit orders and credit notes to Loyalista, create the corresponding flows in Plenty Flow Studio. In your PlentyONE system, navigate to Automation >> Flow Studio. For detailed information about flows, refer to the PlentyONE manual on Plenty Flow Studio.

1. Send orders to Loyalista

Create a new event-based flow in Plenty Flow Studio (Figure 11). Configure the settings as shown in Table 9 and then activate the flow:

Setting	Value
Trigger selection	Payment status
Payment status	Fully paid
Execution mode	One flow per ID
Filter	Order type: Is in (IN) >> Order
Filter	Client: Is in (IN) >> Select the desired shop/client
Action	Loyalista: Send order to Loyalista

Activate the flow to start automatically transmitting orders to Loyalista.

2. Send credit notes to Loyalista

Create a second event-based flow (Figure 12). Configure the settings as shown in Table 10 and then activate the flow:

Setting	Value
Trigger selection	Payment status
Payment status	Fully paid
Execution mode	One flow per ID
Filter	Order type: Is in (IN) >> Credit note
Filter	Client: Is in (IN) >> Select the desired shop/client
Action	Loyalista: Send credit note to Loyalista

Activate the flow to start automatically transmitting credit notes to Loyalista.