📌 Purpose

This recipe walks through the process of setting up a new company along with a loyalty program where customers receive a variety of rewards, including gamified offers, such as access to tiers with premium benefits, completing quests and receiving a free item after collecting a minimum amount of stamps. Such offers can help stretch product or category spend and encourage repeat transactions. The end result is a fully configured three-level unit hierarchy, along with a points scheme, tiers and various campaign types. 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 tiers and campaigns. Multiple 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.

📋 Prerequisites

Eagle Eye API access: required to make API calls
Company unit's clientId & secret: required to make API calls
Points base earn and expiry rules, if applicable
Company, banner and store names and unique alphanumeric identifiers 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:

Output Name	Purpose
incomingIdentifier	Client assigned alphanumeric value used in banner, campaigns and loyalty rules
schemeId	System assigned identifier for your loyalty program points rules
campaignId	Auto assigned identifier for campaigns
walletId	Identifier for customers' wallets, often used in APIs
accountId	Identifier for points or coupon accounts assigned to a wallet
tierId	Identifier for loyalty tiers

📒 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 Unit

1.2 - Create Banners

1.3 - Create Stores

Step 2: Setup Loyalty Points Rules

Define how customers will earn and spend 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 & Burn Rules with Tiers

Step 3: Setup Loyalty Tiers

Follow this step to create a bronze, silver and gold tier against your loyalty scheme from step 2.

3.1 - Create a Set of Loyalty Tiers

Step 4: Sample Campaigns

This section will detail how to create an initial offer, Continuity with a coupon as a reward, Stamp Card and Quest campaign types. It is best practice to set these campaigns as targeted to personalise the coupon creation, allowing customers to browse, select and load their chosen offers.