v1
latestOpenAPI 3.0.12026-07-21161785.3 KBRedemptions & Discount Codes
Get all point redemption rules
get/api/external/point-redeem-rules
Headers
X-API-Keystring required
API key for authentication
Response
Successfully retrieved point redemption rules
allowedCountriesstring
allowedCustomerTagsstring
appliesOn'ONE_TIME' | 'SUBSCRIPTION' | 'BOTH'
applyDiscountOnceboolean
applyToEachItemboolean
collectionDatastring
collectionIdinteger
combinedWithOrderDiscountboolean
combinedWithProductDiscountboolean
combinedWithShippingDiscountboolean
createAtstring date-time
customerFacingIconUrlstring
customerFacingLabelstring
discountnumber double required
discountCodeForAllCustomerboolean
discountCodeNodeIdstring
discountPrefixTextstring
discountType'PERCENTAGE' | 'FIXED' required
earnRuleIdinteger
enableDiscountPrefixboolean
enableIntervalboolean
enableMaximumPointsToRedeemboolean
enableMinimumPointsToRedeemboolean
enableNumberOfUsagesLimitboolean
enablePOSboolean
idinteger
maximumPointsLabelstring
maximumShippingRatenumber double
minimumPointsLabelstring
minimumPurchaseAmountnumber double required
namestring required
numberOfUsagesLimitinteger
pointsCostnumber double
productDatastring
productIdinteger
quantityinteger
redeemAllPointsboolean
redeemLabelstring
redeemLimitinteger
redeemPointsnumber double required
referralType'EXISTING_CUSTOMER_REWARD' | 'NEW_CUSTOMER_REWARD' | 'VIP'
requiredMaximumPointsToRedeemnumber double
requiredMinimumPointsToRedeemnumber double
restrictCustomersstring
restrictCustomersWithTagsstring
rewardInterval'DAY' | 'WEEK' | 'MONTH' | 'YEAR' | 'LIFETIME'
serialinteger
shopstring
showInPosOnlyboolean
status'ACTIVE' | 'INACTIVE' required
translationsstring
triggeredCountinteger
type'DISCOUNT_CODE' | 'FREE_PRODUCT' | 'FREE_SHIPPING' | 'PRODUCT_DISCOUNT' | 'COLLECTION_DISCOUNT' | 'BIRTHDAY_REWARD' | 'DYNAMIC_DISCOUNT' | 'STATIC_REDEEM_RULE' | 'STORE_CREDIT' required
updateAtstring date-time
variantIdinteger
vipTierIdinteger