All rewards available of the customer, including all basic information of rewards.
Returns
autoStackLimit ● Boolean
If the rewards allow stacking with automatic discounts.
benefitsCode ● String
Benefit discount code.
benefitsDetails ● String
When rewardType is CASHBACK, PERCENTAGE_DISCOUNT, CASH_VOUCHER, FREE_SHIPPING, it represents the discount value for these benefits, such as x% off.
benefitsUsageInstructionType ● BenefitsUsageInstructionType
Benefit usage condition type.
benefitsUsageInstructionValue ● String
Relevant only when rewardScene = BIRTH_BENEFITS,or rewardType = PERCENTAGE_DISCOUNT or CASH_VOUCHER. This indicates the value corresponding to the benefitsUsageInstructionType.
codeStackLimit ● Boolean
If the rewards allow stacking with discount code.
couponStatus ● Boolean
Availability of the coupon.
couponStatusDetail ● couponStatusDetail
Relevant only when couponStatus = false.
couponUsageScope ● CouponUsageScope
Discount code usage scope.
createdAt ● Date
Time when the reward was created.
redeemPointsValue ● Int
The number of points used when redeeming rewards. Relevant only when rewardSource = POINTS_REDEMPTION.
rewardAcquireTime ● Date
Time when the reward was acquired.
rewardExpiryTime ● Date
Time when the reward expires. This field is empty when the reward does not expire.
rewardScene ● RewardScene
Scene of rewards.
rewardSource ● RewardSource
Source of the reward.
rewardType ● RewardType
Type of rewards
usageLimits ● Int
When rewardType is CASHBACK, PERCENTAGE_DISCOUNT, CASH_VOUCHER, FREE_SHIPPING, and FREE_PRODUCT, it indicates the usage limit for these discounts, and null indicates unlimited usage.
Was this article helpful to you?