LUCampaignRepresentationVisitBasedLoyaltyV1 Class Reference
Inherits from | LUAPIModel : NSObject |
Declared in | LUCampaignRepresentationVisitBasedLoyaltyV1.h LUCampaignRepresentationVisitBasedLoyaltyV1.m |
Overview
A representation of a visit based loyalty campaign, which means that credit is unlocked every time the user visits the merchant a certain number of times. “Visiting” means placing an order greater than or equal to the qualifying spend amount at the merchant.
Tasks
-
campaignID
property -
earn
property -
progressVisitCount
property -
qualifyingOrderSpend
property -
requiredVisitCount
property
Properties
campaignID
The campaign’s ID.
@property (nonatomic, readonly, copy) NSNumber *campaignID
Discussion
The campaign’s ID.
Declared In
LUCampaignRepresentationVisitBasedLoyaltyV1.h
earn
The amount of money earned after visiting enough times to unlock credit.
@property (nonatomic, strong, readonly) LUMonetaryValue *earn
Discussion
The amount of money earned after visiting enough times to unlock credit.
Declared In
LUCampaignRepresentationVisitBasedLoyaltyV1.h
progressVisitCount
The user’s progress towards unlocking credit.
@property (nonatomic, assign, readonly) NSUInteger progressVisitCount
Discussion
The user’s progress towards unlocking credit.
After unlocking credit, this number will cycle back to zero. For example, say requiredVisitCount
is 10. As the user visits the merchant, progressVisitCount
moves 10. Once they have visited 10
times, they unlock credit, and then progressVisitCount
cycles back to 0 and continues to move
towards 10 as more visits occur.
If this campaign representation is requested without an authenticated user, progressVisitCount
will always be 0.
Declared In
LUCampaignRepresentationVisitBasedLoyaltyV1.h
qualifyingOrderSpend
The minimum amount of money that must be spent for an order to qualify as a “visit”.
@property (nonatomic, strong, readonly) LUMonetaryValue *qualifyingOrderSpend
Discussion
The minimum amount of money that must be spent for an order to qualify as a “visit”.
If there is no minimum amount, this will be $0.
Declared In
LUCampaignRepresentationVisitBasedLoyaltyV1.h
requiredVisitCount
The number of visits a user must make at the merchant in order to unlock credit.
@property (nonatomic, assign, readonly) NSUInteger requiredVisitCount
Discussion
The number of visits a user must make at the merchant in order to unlock credit.
Declared In
LUCampaignRepresentationVisitBasedLoyaltyV1.h