All rewards available of the customer, including all basic information of rewards.
Fields
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.
More
codeStackLimit ● Boolean
If the rewards allow stacking with discount code.
couponStatus ● Boolean
Availability of the coupon.
couponStatusDetail ● couponStatusDetail
Relevant only when couponStatus = false.
More
couponUsageScope ● CouponUsageScope
Discount code usage scope.
More
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.
More
rewardSource ● RewardSource
Source of the reward.
More
rewardType ● RewardType
Type of rewards
More
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.
Status and error codes
For detailed information about common codes, see Status and error codes.
Was this article helpful to you?