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.

  • DISCOUNT_AMOUNT: Discount reward. Special flexible reward type used in checkout.
  • COUPON_REWARD: Coupon reward. Learn more about coupons.

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.

Did this help?