The details of a point redemption rule.
Fields
id ● ID
The rule ID.
name ● String
The rule name.
customisedDescription ● String
The custom description of the rule.
icon ● String
The URL of the rule icon.
channel ● PointRuleChannel
The applicable channel for the rule.
More
allowRevokeRedemption ● Boolean
Whether redemption cancellation is allowed.
  • true: Allowed
  • false: Not allowed
ruleType ● RuleType
The type of point deduction.
More
The configuration for point redemption benefits.
More
pointsAutoDeduct ● Boolean
Whether points are automatically applied as a cash offset at checkout. Valid only when ruleType is CASHBACK.
  • true: Automatically applied
  • false: Not automatically applied
disablePointsRefund ● Boolean
Whether points are non-refundable when an order is refunded. Valid only when ruleType is CASHBACK.
  • true: Points are non-refundable.
  • false: Points are refundable.
benefitRedemptionCondition ● BenefitRedemptionCondition
The benefit redemption condition configuration.
More
cashbackbenefitsUsageThreshold ● CashbackBenefitsUsageThreshold
The usage thresholds and restrictions for applying points as a cash offset.
More
couponUsageScope ● CouponUsageScope
The scope of users eligible to use the coupons.
More
productsApplicableType ● ProductsApplicableType
The scope of applicable products.
More
autoStackLimit ● Boolean
Whether the rule can be combined with automatic discounts.
  • true: Combinable
  • false: Not combinable
codeStackLimit ● Boolean
Whether the rule can be combined with discount codes.
  • true: Combinable
  • false: Not combinable
expiryRule ● Int
The validity period (in days) of the benefit after point redemption. A value of null indicates that the benefit is valid indefinitely.
redemptionLimit ● RedemptionLimit
The limit on the number of redemptions.
More
specificCategoryIds ● [ID]
A list of the IDs of the applicable product collections. Valid only when productsApplicableType is SPECIFIC_CATEGORY.
specificProductIds ● [ID]
A list of the IDs of the applicable products. Valid only when productsApplicableType is SPECIFIC_PRODUCT.
Was this article helpful to you?