Loyalty API
TypeAvailableReward1
Describes a reward that can be used by a customer.
| Kind | Type |
|---|---|
| Used in | CustomerBalance3, LoggedOutBalance1 |
Properties
-
typestring requiredIdentifies a particular kind of reward.
-
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) discount code or gift card code.
-
A time when the reward became available, in case you want to display this or sort by this field.
-
The 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 discount code gives, if applicable.
Only present for point redemptions, and for vendible redemptions in certain configurations.