Introduction

This document will guide you through Magento referral program integration. We will have a detailed understanding of installing Magento extension to get started with Zinrelo rewards program quickly.

This extension for Magento renders the loyalty dashboard to members, it automatically tracks orders placed and returned on the Magento store and awards or deducts points accordingly.

Plugin-integrated features

The detailed view is mentioned here.

Installation steps

Install via Composer

1. Go to https://marketplace.magento.com/zinrelo-extension.html

2. From the "Edition" dropdown, select the required edition.
3. From the "Your store version" dropdown, select "2.4 (Open Source (CE))."
4. Click "Add to Cart" and then "Proceed to Checkout."
5. Log in with your credentials.

6. Enter all required details and then click "Place order."

7. Click on "Install."

8. To install the module in your Magento instance, connect to Magento’s command line interface and execute the below commands at Magento’s root directory.

composer require zinrelo/extension
php bin/magento module:enable Zinrelo_LoyaltyRewards
php bin/magento setup:upgrade

Install using zip file

1. Download the latest version of the module from our git repository.
   (https://github.com/zinrelo-code/zinrelo-magento)
2. Once you have the zip, got to magento’s root directory and create below
   directory. app/code/Zinrelo/LoyaltyRewards
3. Extract the zip file into this directory.
4. Execute below commands:

composer require firebase/php-jwt
php bin/magento module:enable Zinrelo_LoyaltyRewards
php bin/magento setup:upgrade

Admin configuration

After successful installation, login to your Magento admin panel and navigate to the Stores>> Configuration>> Zinrelo Loyalty Rewards>> Zinrelo Settings for configuration.

• Enable the loyalty rewards module: The admin can enable or disable the module by selecting Yes or No respectively. Enable module to make working Zinrelo Loyalty Rewards functionality. If disabled, then the module functionalities will not work.
• Add Partner id: Enter Zinrelo store's Partner ID for the API authentication. To get Partner ID, refer the url.
• Add API Key: Enter Zinrelo store's API Key for the API authentication. To get API key, refer the url.
• Add API Key Identifier: Enter Zinrelo store's API key identifier. To get API key identifier, refer to this document.
• Webhook URL: Specify the Webhook URL to send the Event API request.

📘

Note: The webhook url will be shared by Zinrelo. Contact your account manager for the webhook url.

• Enable reward points text on product pages: Select “Yes” from the drop-down to enable the display of Reward points at product detail page.
• Reward points text on product pages: Define a label for the Reward Points to show at product detail page. Add the {{EARN_POINT}} variable where you want to show the points.
• Enable in-cart redemption: Select “Yes” from the drop-down to enable the view Reward list on the cart page.
• In-cart redemption text: Define the label for the reward point drop-down field to show at cart page. Add the {{AVAILABLE_POINTS}} variable where you want to show points.
• Free Shipping Reward Label: Define the label for the Free Shipping Method to show.
• Language (Locale): Zinrelo supports 5 languages by default, 'english', 'french', 'italian', 'german', 'spanish'. For any other languages other than the above one should be mapped and synced with ‘custom language one’ or ‘custom language two’. If no language is added, or if the "use system value" checkbox is checked, the system will use the default language as the store language.
• Reward Events: Select the events from the list to send request to Zinrelo when that Event is called at Magento. When the event will be fired then a log will be generated for request-response data and it will help in tracking the fired event data.
• Cart session timeout: Enter the time in minutes that will be considered to reject pending reward point for abandoned cart and send abandoned cart requests.

Note: Make sure you add webhook URL provided by your account manager.

Once you are done will configuration, click on "Save Config."

Integrated plugin features

📘

Please Note:

These features are integrated through plugins. If you want to incorporate additional features into your cart beyond these, please reach out to your account manager.

Front view

Once you are done with admin configuration, go to your website. There you will see a Rewards Program button at the bottom corner of every front store page.

If you have enabled "Enable reward points text on product pages" in admin configuration, your members will see a text showing how many points they will earn if they place an order.

In-cart functionality

To enable in-cart functionality in your store, enable the given button in the Magento admin settings:

This extension allows the member to redeem reward points and get different types of discounts on various occasions. There are 4 types of rewards available for the redeem.

• Product Redemption
• Fixed Amount Discount
• Percentage Discount
• Free Shipping

From the four rules listed above, members can choose to redeem one reward and get a discount based on the criteria and conditions set for that reward. If the member doesn't have enough points or has wrong authentication information, the rules won't show up in the drop-down menu. Also, members can cancel a reward they've already claimed and claim it again if they want to.

Note: The rewards will be available to registered customers only.

How rewards function

• Product Redemption: When selected, the member will get the free product in his cart and can complete his order with the excluded price of the free product in the order subtotal.

Note: Make sure the requested free product exists in the Magento store; otherwise, this reward will not be applied.

• Free Shipping: When selected, the member will not be charged any shipping charges.

• Fixed Amount Discount: When selected, the member will get a fixed discount on the order subtotal.

• Percentage Discount: When selected, the member will get some percent off applied to his order subtotal.

Please Note:

1. You can look at the subtotal and grand total of the order to see how the discount was used. It will be reflected in the order, invoice, and refund. Also, you will get the discount details in the invoice, credit memo, and order print page.

2. The applied reward and managed discount will also be available to admin for the review. Admin can view that applied reward discount in the order view and the managed discount in the order subtotal.

Recommendations

For clients supporting Online or Cash on Delivery (COD), we recommend the following configuration:

• Award points on Order Complete
• Return points on Order Refund or Cancelled.

Summary

The help document provides instructions for integrating Zinrelo's loyalty rewards program with the Magento e-commerce platform. It involves installing the Zinrelo extension from the Magento Marketplace and then configuring it to customize the appearance and behavior of the loyalty program. This includes adding loyalty program widgets to store pages to display rewards and encourage customer engagement. Overall, the integration is designed to help businesses incentivize and retain customers through a comprehensive loyalty program.