Basic information about membership level benefits.
Returns
autoStackLimit ● Boolean
If the rewards allow stacking with automatic discounts.
benefitsDescription ● String
Description of the benefit. Only relevant when membershipType = PAID. Maximum 500 characters.
benefitsDetails ● String
When rewardType is PERCENTAGE_DISCOUNT, CASH_VOUCHER, FREE_SHIPPING or POINTS, it represents the discount value for these benefits, such as x% off.
benefitsExpiryDateType ● BenefitsExpiryDateType
The validity period type of the benefit. Only valid when membershipType = PAID.
benefitsExpiryDateValue ● Int
Benefits expire x days after issuance, and return value x. Only relevant when benefitsExpiryDateType = SPECIFIC_DATE.
benefitsIcon ● String
The URL of the benefits icon
benefitsIssuranceType ● BenefitsIssuranceType
The time when the benefits are issued. Only relevant when membershipType = PAID.
benefitsName ● String
Benefit name. Only relevant when membershipType = PAID. Maximum 25 characters
benefitsUsageInstructionType ● BenefitsUsageInstructionType
Benefit usage condition type.
benefitsUsageInstructionValue ● String
Relevant only when rewardType = PERCENTAGE_DISCOUNT or CASH_VOUCHER or FREE_SHIPPING. This indicates the value corresponding to the benefitsUsageInstructionType.
birthBenefitsReleaseType ● BirthBenefitsReleaseType
Birthday month benefit issurance time type. Relevant when rewardScene = BIRTH_BENEFITS.
codeStackLimit ● Boolean
If the rewards allow stacking with discount code.
daysBefore ● Int
Only relevant when birthBenefitsReleaseType = FIXED_BEFORE
fixedDate ● Int
The date of the monthly release.
periodicallyDays ● Int
Benefits are issued every x days, and the value x is returned.
periodicallyMonths ● Int
Benefits are issued every x calendar months, and the value x is returned.
productsApplicableType ● ProductsApplicableType
Applicable product range. Relevant when rewardScene = BIRTH_BENEFITS, or rewardType = PERCENTAGE_DISCOUNT or CASH_VOUCHER or FREE_SHIPPING.
rewardType ● RewardType
Type of rewards
specificCategoryList ● [String]
A list of applicable product category IDs. Only relevant when productsApplicableType = SPECIFIC_CATEGORY.
specificDate ● String
Benefit issuance date. Format: MM-DD. Only relevant when benefitsIssuranceType = SPECIFIC_DATE
specificProductIds ● String
Applicable product IDs. Only relevant when productsApplicableType = SPECIFIC_PRODUCT.
usageLimitsTimes ● Int
The number of the usage time limitation. Relevant only when usageLimitsType = LIMITS.
usageLimitsType ● UsageLimitsType
If there is usage time limits.
Map
BenefitsInfo
Was this article helpful to you?