Get all point redemption rules

GET /api/external/point-redeem-rules

Get all point redemption rules

cURL

curl --request GET \
  --url https://loyalty-admin.appstle.com/api/external/point-redeem-rules \
  --header 'X-API-Key: <x-api-key>'

200

{
  "name": "<string>",
  "redeemPoints": 123,
  "discount": 123,
  "minimumPurchaseAmount": 123,
  "id": 123,
  "shop": "<string>",
  "createAt": "2023-11-07T05:31:56Z",
  "updateAt": "2023-11-07T05:31:56Z",
  "maximumShippingRate": 123,
  "productId": 123,
  "variantId": 123,
  "productData": "<string>",
  "collectionId": 123,
  "collectionData": "<string>",
  "customerFacingLabel": "<string>",
  "restrictCustomers": "<string>",
  "restrictCustomersWithTags": "<string>",
  "combinedWithProductDiscount": true,
  "combinedWithShippingDiscount": true,
  "combinedWithOrderDiscount": true,
  "triggeredCount": 123,
  "pointsCost": 123,
  "enableInterval": true,
  "redeemLimit": 123,
  "enableNumberOfUsagesLimit": true,
  "numberOfUsagesLimit": 123,
  "allowedCustomerTags": "<string>",
  "earnRuleId": 123,
  "vipTierId": 123,
  "redeemLabel": "<string>",
  "customerFacingIconUrl": "<string>",
  "serial": 123,
  "discountCodeForAllCustomer": true,
  "allowedCountries": "<string>",
  "showInPosOnly": true,
  "redeemAllPoints": true,
  "enableMinimumPointsToRedeem": true,
  "requiredMinimumPointsToRedeem": 123,
  "enableMaximumPointsToRedeem": true,
  "requiredMaximumPointsToRedeem": 123,
  "enablePOS": true,
  "minimumPointsLabel": "<string>",
  "maximumPointsLabel": "<string>",
  "applyDiscountOnce": true,
  "enableDiscountPrefix": true,
  "discountPrefixText": "<string>",
  "discountCodeNodeId": "<string>",
  "translations": "<string>",
  "quantity": 123,
  "applyToEachItem": true
}

Headers

X-API-Key · string · required

API key for authentication

Response

200

application/json

Successfully retrieved point redemption rules

name · string · required

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

status · enum<string> · required

Available options: ACTIVE, INACTIVE

redeemPoints · number<double> · required

discountType · enum<string> · required

Available options: PERCENTAGE, FIXED

discount · number<double> · required

minimumPurchaseAmount · number<double> · required

id · integer<int64>

shop · string

referralType · enum<string>

Available options: EXISTING_CUSTOMER_REWARD, NEW_CUSTOMER_REWARD, VIP

createAt · string<date-time>

updateAt · string<date-time>

maximumShippingRate · number<double>

productId · integer<int64>

variantId · integer<int64>

productData · string

collectionId · integer<int64>

collectionData · string

customerFacingLabel · string

restrictCustomers · string

restrictCustomersWithTags · string

rewardInterval · enum<string>

Available options: DAY, WEEK, MONTH, YEAR, LIFETIME

appliesOn · enum<string>

Available options: ONE_TIME, SUBSCRIPTION, BOTH

combinedWithProductDiscount · boolean

combinedWithShippingDiscount · boolean

combinedWithOrderDiscount · boolean

triggeredCount · integer<int64>

pointsCost · number<double>

enableInterval · boolean

redeemLimit · integer<int32>

enableNumberOfUsagesLimit · boolean

numberOfUsagesLimit · integer<int32>

allowedCustomerTags · string

earnRuleId · integer<int64>

vipTierId · integer<int64>

redeemLabel · string

customerFacingIconUrl · string

serial · integer<int32>

discountCodeForAllCustomer · boolean

allowedCountries · string

showInPosOnly · boolean

redeemAllPoints · boolean

enableMinimumPointsToRedeem · boolean

requiredMinimumPointsToRedeem · number<double>

enableMaximumPointsToRedeem · boolean

requiredMaximumPointsToRedeem · number<double>

enablePOS · boolean

minimumPointsLabel · string

maximumPointsLabel · string

applyDiscountOnce · boolean

enableDiscountPrefix · boolean

discountPrefixText · string

discountCodeNodeId · string

translations · string

quantity · integer<int32>

applyToEachItem · boolean