Inherits from LUAPIModel : NSObject
Declared in LULoyalty.h
LULoyalty.m

Overview

LULoyalty represents a user’s loyalty information at a specific merchant. At most merchants, users will build loyalty as they make purchases at that merchant. Periodically, they will be rewarded with credit after spending a merchant-defined amount of money. For example, a merchant may choose to provide the user with $10 in credit for every $100 they spend. This is ongoing, so after spending $100 and receiving $10 in credit, the user must spend another $100 before they receive another $10 in credit.

In addition, users may receive credit at a merchant through other means, such as campaigns or global credit. LULoyalty includes this information as well.

Tasks

Properties

merchantID

The ID of the merchant this LULoyalty is for.

@property (nonatomic, copy, readonly) NSNumber *merchantID

Discussion

The ID of the merchant this LULoyalty is for.

Declared In

LULoyalty.h

merchantLoyaltyEnabled

A small percent of LevelUp merchants do not provide loyalty rewards. This property specifies if the merchant has loyalty enabled.

@property (nonatomic, assign, readonly) BOOL merchantLoyaltyEnabled

Discussion

A small percent of LevelUp merchants do not provide loyalty rewards. This property specifies if the merchant has loyalty enabled.

Declared In

LULoyalty.h

ordersCount

The number of orders the user has made at this merchant.

@property (nonatomic, copy, readonly) NSNumber *ordersCount

Discussion

The number of orders the user has made at this merchant.

Declared In

LULoyalty.h

potentialCredit

The total amount of credit available to the user at this merchant. This includes merchant-specific credit, global credit and campaign credit.

@property (nonatomic, strong, readonly) LUMonetaryValue *potentialCredit

Discussion

The total amount of credit available to the user at this merchant. This includes merchant-specific credit, global credit and campaign credit.

Declared In

LULoyalty.h

progressPercent

The user’s progress towards receiving more loyalty credit, as a number between 0.0 and 1.0. For example, if a merchant provides credit for every $50 spent, and the user has spent $10, this number would be 0.2.

@property (nonatomic, assign, readonly) float progressPercent

Discussion

The user’s progress towards receiving more loyalty credit, as a number between 0.0 and 1.0. For example, if a merchant provides credit for every $50 spent, and the user has spent $10, this number would be 0.2.

Declared In

LULoyalty.h

savings

The total amount of money that this user has saved at this merchant; that is, the total amount of credit that has been applied to orders at this merchant over all time.

@property (nonatomic, strong, readonly) LUMonetaryValue *savings

Discussion

The total amount of money that this user has saved at this merchant; that is, the total amount of credit that has been applied to orders at this merchant over all time.

Declared In

LULoyalty.h

shouldSpend

The amount of money a user spends at this merchant before receiving loyalty credit. For example if a merchant provides $10 of credit for every $100 spent, this will return $100.

@property (nonatomic, strong, readonly) LUMonetaryValue *shouldSpend

Discussion

The amount of money a user spends at this merchant before receiving loyalty credit. For example if a merchant provides $10 of credit for every $100 spent, this will return $100.

Declared In

LULoyalty.h

spendRemaining

The amount of money remaining for the user before they will receive loyalty credit. For example if a merchant provides $10 of credit for every $100 spent, and the user has spent $25 since the last time they received loyalty, this would return $75.

@property (nonatomic, strong, readonly) LUMonetaryValue *spendRemaining

Discussion

The amount of money remaining for the user before they will receive loyalty credit. For example if a merchant provides $10 of credit for every $100 spent, and the user has spent $25 since the last time they received loyalty, this would return $75.

Declared In

LULoyalty.h

totalVolume

The total amount money the user has spent at this merchant over all time.

@property (nonatomic, strong, readonly) LUMonetaryValue *totalVolume

Discussion

The total amount money the user has spent at this merchant over all time.

Declared In

LULoyalty.h

willEarn

The amount of loyalty credit a user receives at this merchant. For example if a merchant provides $10 of credit for every $100 spent, this will return $10.

@property (nonatomic, strong, readonly) LUMonetaryValue *willEarn

Discussion

The amount of loyalty credit a user receives at this merchant. For example if a merchant provides $10 of credit for every $100 spent, this will return $10.

Declared In

LULoyalty.h