Skip to main content
GET
/
loyalty_statuses
Please review proper request headers here.

​
Parameters

​
merchant_id
string
Only return loyalty status for this merchant

​
Response

​
id
string
The ID of the settings record
​
user_id
string
The ID of the user
​
merchant_id
string
The ID of the merchant
​
status
hash
The user’s loyalty information
​
status.progress
integer
The user’s progress toward their reward, out of 100
​
status.type
enum
Whether the user earns progress via how much they spend or how many times they visit. Returns spend or visit.
​
status.threshold
integer
How much the user needs to spend or how many visits the user needs to make to earn the reward.
​
redeem
hash
Describes the reward the user would earn
​
redeem.type
enum
How the reward can be redeemed (manual, automatic)
​
redeem.text
string
Description of what the reward is
​
redeem.venue
enum
Where the reward can be used: (instore, online, all)