Real-Time Tender Recipe
📌 Purpose
This recipe guides you through setting up your retailer loyalty program so customers can earn points on their purchases and spend them on future shopping trips. By the end of this recipe, you will have configured your brand, banners, and stores, defined how customers earn points, and created sample offers that can drive loyalty and repeat visits.
🖼 Recipe Overview
You will start by creating your retailer brand and stores, which form the foundation for your loyalty program. Then you will set up how customers earn points and define offers they can redeem, ensuring your program is ready for launch. The recipe also includes four sample campaigns setups that will walk you through the setup of offers that will issue the following: fixed amount of points for spend over time, a fixed discount on a basket spend, fixed amount of points on a single transaction and a points multiplier for specific products.
📋 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:
| 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 |
📒 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 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.
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.
3.1 - Continuity
3.2 - Discount Basket
3.3 - Points Fixed
Step 4: Sample Customer Wallets
Create test customer wallets to simulate real customer experiences. This step ensures each wallet correctly displays points balances and campaign offers, allowing you to test end-to-end functionality before activating the program for live customers.
4.1 - Create a Consumer Wallet
With these steps complete, your loyalty program will be ready for internal validation and external launch, ensuring customers receive a seamless and rewarding experience.
✅ 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 and burn points as part of your loyalty program?
- Continuity Campaign
- Discount Basket Campaign
- Points Fixed Campaign
- Product Points Multiplier Campaign
- Are test customer wallets available ready?
🔧 Troubleshooting Tips
Updated about 4 hours ago
