Reward Object


A loyalty reward is an object a customer can redeem with loyalty points. Redeeming a reward then creates a loyalty coupon that the customer can use.

Properties
activeboolean

Whether the reward is active. Default: FALSE


createdDatestringRead-onlyformat date-time

Date and time the reward was created.


idstringRead-onlyformat GUID

Reward ID.


namestringminLength 1maxLength 50

Reward name.


revisionstringRead-onlyformat uint64

Revision number, which increments by 1 each time the loyalty reward is updated.

To prevent conflicting changes, the current revision must be passed when updating the loyalty reward.


typestring

Reward type.


One Of

couponRewardCouponReward

Coupon details.


discountAmountDiscountAmount

Discount details.


updatedDatestringRead-onlyformat date-time

Date and time the reward was last updated.

Did this help?