Setting Up Loyalty & Referrals on Adobe Commerce 1

This article provides a comprehensive walkthrough of the steps required to install Yotpo Loyalty & Referrals on the Adobe Commerce 1 (previously Magento 1) extension.

Step 1: Create/Log In to Yotpo Loyalty & Referrals Account

To get started:

Log in to your account or create a new one by clicking here.

Step 2: Install the Adobe Commerce 1 Extension

To get started, you'll need to download the Adobe Commerce 1 extension to your server and then copy the files into the correct directories.  The following instructions assume you have your Adobe Commerce instance installed at /var/www/magento.  If Adobe Commerce is installed in a different location, you'll need to update the instance location to match your setup.

wget -O magento1-module-yotpo-loyalty-master.zip https://github.com/YotpoLtd/magento1-module-yotpo-loyalty/archive/master.zip

unzip magento1-module-yotpo-loyalty-master.zip

sudo cp -R magento1-module-yotpo-loyalty-master/* /var/www/magento

1. Flush the Adobe Commerce Cache
2. Log out of your Adobe Commerce Admin
3. Log back in to your Adobe Commerce Admin
4. Once you're logged back in, click System
5. Click Configuration

6. In the System > Configuration section of your Adobe Commerce admin, select the store you'd like to install Loyalty & Referrals on. You can select the relevant store from the dropdown in the top-left section.

7. Once you've selected the relevant store, you'll see a new menu item in the left-hand pane under Loyalty & Referrals. Click Loyalty & Referrals Setup in the Configuration section.

8. Copy and paste your API Key and GUID from the Loyalty & Referrals Admin where promoted.  Once you've entered your API credentials, click on the Save Config button in the top right corner.

• If all goes well, you'll see a green notification indicating that the setup is complete. 
• If you're prompted with an error message, please make sure that your API Key and GUID match the values shown in the Loyalty & Referrals admin.  
  • If you're sure you've entered the correct API Key and GUID and you're still seeing an error, it's possible that the Loyalty & Referrals API servers are unable to reach your Adobe Commerce Instance. 
  • If you're on an IP-restricted network, you'll need to allow the elastic IP used by Loyalty & Referrals app servers:

• 18.211.49.234
  184.73.97.197
  3.208.146.76
  3.233.194.13
  3.82.123.250
  34.194.51.213
  34.239.23.157
  35.173.225.93
  35.175.18.253
  44.193.150.247
  52.6.112.37
  54.159.57.141
  54.208.164.94
  54.227.16.145
  75.101.169.217
  75.101.219.113
  54.208.166.35
  52.21.63.9
  54.209.107.41
  52.1.212.140
  52.3.97.85

The Cron Based Notifications toggle is used by the extension to decide if it should make requests back to Loyalty & Referrals API synchronously (if set to "No") when orders or customers are created, or asynchronously using Cron (if set to "Yes").

Step 3: Order & Discount Processing

With the Adobe Commerce extension installed, your Adobe Commerce instance will now send notification requests to the Loyalty & Referrals API whenever an order is created or its status is updated.  Since Loyalty & Referrals will be receiving a request for all status updates, you'll need to configure Loyalty & Referrals to know which states and statuses you wish Loyalty & Referrals to act on.

Points Earned vs. Discounts

It's important to understand the difference between processing an order for points earned, and processing discounts applied to an order to deduct points from a customer. 

If you're using Loyalty & Referrals advanced redemption at checkout experience, we recommend delaying the deduction of points from a customer's account until after the order is placed. As customers may change their mind about the number of points they wish to redeem or abandon checkout altogether, it's best to deduct points only after the order is placed.

In the Loyalty & Referrals admin, you can specify RegEx for both the status and the state that you want Loyalty & Referrals to use to process discounts (deduct points used from customer balances) and for when you want Loyalty & Referrals to process the order for points.

• The Order Paid State and Order Paid Status RegEx are used to determine when Loyalty & Referrals should deduct the points for discounts used.
• The Process Order With State and Process Order With Status Regex are used to determine when Loyalty & Referrals should process the order for earning points.
• As a default, we recommend using an order paid state Regex of processing|complete so that Loyalty & Referrals can process a submitted order for points used immediately.
• As a default, we recommend using a process order with state Regex of complete so that we only award points once the order is completed.