📌 Purpose

This recipe walks through the process of setting up a new company along with a loyalty program where customers can exchange points for fixed £ off vouchers. The end result is a fully configured three-level company hierarchy, along with a points scheme, a reward bank and commonly used campaigns. This setup will also allow you to create sample wallets to begin making transactions.

🖼 Recipe Overview

You will begin with creating a new company unit, followed by redemption partner (aka banners) and stores with default settings. Once the units are established a points scheme will be setup prior to the rewards banks and campaigns. Four commonly used campaigns can be created via API with the recipes provided, allowing you to create coupons using a single tag for easy management of initial offers. Steps are provided to assist you in creating wallets, where from a single call you will create the wallet, a consumer object and a points account. Finally a reward bank step will be included to allow customers to exchange points for a tokenized £ off coupon.

📋 Prerequisites

• Eagle Eye API access: required to make API calls
• Company unit's clientId & secret: required to make API calls
• Points base earn and spend rules: needed for points setup
• Company, banner and store names and unique alphanumeric identifiers (no dashes) for each: required to assign against campaigns
• Products ingested for use in product based campaigns: required for campaigns that target specific products

📤 Outputs

Note the following outputs as your complete your steps for use in future API calls and for validation purposes:

📒 Steps

Step 1: Company Creation

Begin by setting up your retailer brand, banners, and stores within the system. This ensures your loyalty program is connected to your operational structure, so all points earning and spending activities are correctly attributed to the right locations your customers shop in.

1.1 - Create Retailer Brand

1.2 - Create Banners

1.3 - Create Stores

Step 2: Setup Loyalty Points Rules

Define how customers will earn points in your loyalty program. Setting up your loyalty scheme establishes the rules for how customers are rewarded, creating clear incentives that drive purchase frequency and brand engagement.

2.1 - Create Loyalty Points Earn Rules

Step 3: Create Sample Campaigns

Set up sample promotional campaigns to demonstrate how your loyalty program can engage customers. These campaigns will include different offer types such as discounts, fixed point rewards, and bonus point incentives, giving you practical examples to validate the program before launch.

🚧

In this recipe, exclude the initialOffers tag in the tags array

3.1 - Discount Basket

3.2 - Points Fixed

3.3 - Product Spend Points Variable

Step 4: Create Reward Banks

To allow the exchange of points for coupon accounts in the wallet, use this section to create public (open) and personal (targeted) rewards banks. Use the campaignIds from step 3 when setting up your reward banks here.

4.1 - Public Reward Bank

4.2 - Personal Reward Bank

Step 5: Sample Customer Wallets

Create test customer wallets to simulate real customer experiences. This step ensures each wallet correctly displays points balances, allowing you to test end-to-end functionality before activating the program for live customers.

🚧

In this recipe, exclude the campaign array in the request payload

5.1 - Create a Consumer Wallet with a Loyalty Points Account

Step 6: Credit Points to the Loyalty Account

Before an exchange can happen against the rewards account, points should be available in the wallet's points account. This step will credit points to the loyalty account created as part of the wallet service create call in step 5.

6.1 - Prepare Credit Points Request

6.2 - Credit Points to Loyalty Account

Step 7: Public Reward Bank Exchange

Now that wallets are created with a points balance, the next step is to exchange the points for coupons from the Reward Banks created in 4.1. This step will focus specifically on the public reward banks exchange process.

7.1 - Public Reward Bank Exchange

Step 8: Personal Reward Bank Exchange

To test the exchange of points for coupons from the Reward Banks created in 4.2, specifically targeted to customer wallets, use this step to setup the presonal reward banks exchange process.

8.1 - Personal Reward Bank Exchange

✅ Business Readiness Checklist

Use these steps to validate the setup of your Loyalty Program:

• Have you confirmed your banners and stores are setup?
• Can customers earn points as part of your loyalty program?
• Discount Basket Campaign
• Points Fixed Campaign
• Product Points Multiplier Campaign
• Public Reward Bank
• Personal Reward Bank
• Are test customer wallets available ready?
• Have the loyalty accounts been credited with points?
• Public Reward Bank Exchange
• Personal Reward Bank Exchange

🔧 Troubleshooting Tips

• Brand, Banners and Stores
• Loyalty Points Program
• Discount Basket Campaign
• Points Fixed Campaign
• Product Points Multiplier Campaign
• Public Reward Bank
• Personal Reward Bank
• Wallets, Coupons and Loyalty Points Accounts
• Loyalty Account Points Credit
• Public Reward Bank Exchange
• Personal Reward Bank Exchange