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
idstringRead-onlyformat GUID

Reward ID.


namestringminLength 1maxLength 50

Reward name.


activeboolean

Whether the reward is active. Default: FALSE


typestring

Reward type.


revisionintegerRead-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.


createdDatestringRead-onlyformat date-time

Date and time the reward was created.


updatedDatestringRead-onlyformat date-time

Date and time the reward was last updated.


ONE OF:

discountAmountDiscountAmount

Discount details.


couponRewardCouponReward

Coupon details.

Reward
JSON
{ "reward": { "id": "00000000-0000-0000-0001-000000000000", "name": "Flexible reward", "requiredPoints": 10, "active": true, "type": "DISCOUNT_AMOUNT", "discountAmount": { "amount": "1", "configsByTier": [ { "amount": "1", "costInPoints": 10 } ] }, "revision": "3", "createdDate": "2024-02-09T09:07:32.797Z", "updatedDate": "2024-03-07T15:47:19.402Z" } }
Did this help?