Loyalty API
TypeAvailableReward1
Describes a reward that can be used by a customer.
| Kind | Type |
|---|---|
| Used in | CustomerBalance3, ListCustomers3, LoggedOutBalance1 |
Properties
-
typestring requiredIdentifies a particular kind of reward.
coupon_rewardmarks a granted gift coupon, such as a birthday or anniversary gift. It has noptsorchange_bhid. -
descstring requiredDescribes the source of the reward, suitable to be a list item title.
-
reward_descstring optionalDescribes a particular benefit the user will get when they use the code, suitable to be a list item subtitle.
-
codestring requiredOnline shop (e.g. Shopify) coupon code or gift card code.
Empty for rewards redeemed for in-store use (see channel), and for
coupon_rewardentries created without a coupon code. -
A time when the reward became available, in case you want to display this or sort by this field.
-
ptsinteger optionalThe number of points spent for this reward, if applicable.
If the reward has been obtained without spending points, this field will be null or missing
-
A fixed amount benefit the coupon code gives, if applicable.
Only present for point redemptions, and for vendible redemptions in certain configurations.
-
statusstring optionalRedemption status of the reward, e.g. pending.
-
change_bhidstring optionalBubblehouse ID of the redemption change behind this reward.
Needed to cancel a pending redemption through Unredeem1.
-
channelstring optionalRedemption channel chosen by the customer.
Set to retail for rewards redeemed for in-store use; absent otherwise.