Skip to main content
GET
Get all point redemption rules

Headers

X-API-Key
string
required

API key for authentication

Response

Successfully retrieved point redemption rules

discount
number<double>
required
discountType
enum<string>
required
Available options:
PERCENTAGE,
FIXED
minimumPurchaseAmount
number<double>
required
name
string
required
redeemPoints
number<double>
required
status
enum<string>
required
Available options:
ACTIVE,
INACTIVE
type
enum<string>
required
Available options:
DISCOUNT_CODE,
FREE_PRODUCT,
FREE_SHIPPING,
PRODUCT_DISCOUNT,
COLLECTION_DISCOUNT,
BIRTHDAY_REWARD,
DYNAMIC_DISCOUNT,
STATIC_REDEEM_RULE,
STORE_CREDIT
allowedCountries
string
allowedCustomerTags
string
appliesOn
enum<string>
Available options:
ONE_TIME,
SUBSCRIPTION,
BOTH
applyDiscountOnce
boolean
applyToEachItem
boolean
collectionData
string
collectionId
integer<int64>
combinedWithOrderDiscount
boolean
combinedWithProductDiscount
boolean
combinedWithShippingDiscount
boolean
createAt
string<date-time>
customerFacingIconUrl
string
customerFacingLabel
string
discountCodeForAllCustomer
boolean
discountCodeNodeId
string
discountPrefixText
string
earnRuleId
integer<int64>
enableDiscountPrefix
boolean
enableInterval
boolean
enableMaximumPointsToRedeem
boolean
enableMinimumPointsToRedeem
boolean
enableNumberOfUsagesLimit
boolean
enablePOS
boolean
id
integer<int64>
maximumPointsLabel
string
maximumShippingRate
number<double>
minimumPointsLabel
string
numberOfUsagesLimit
integer<int32>
pointsCost
number<double>
productData
string
productId
integer<int64>
quantity
integer<int32>
redeemAllPoints
boolean
redeemLabel
string
redeemLimit
integer<int32>
referralType
enum<string>
Available options:
EXISTING_CUSTOMER_REWARD,
NEW_CUSTOMER_REWARD,
VIP
requiredMaximumPointsToRedeem
number<double>
requiredMinimumPointsToRedeem
number<double>
restrictCustomers
string
restrictCustomersWithTags
string
rewardInterval
enum<string>
Available options:
DAY,
WEEK,
MONTH,
YEAR,
LIFETIME
serial
integer<int32>
shop
string
showInPosOnly
boolean
translations
string
triggeredCount
integer<int64>
updateAt
string<date-time>
variantId
integer<int64>
vipTierId
integer<int64>