Skip to main content
GET
/
api
/
external
/
point-redeem-rules
Get all point redemption rules
curl --request GET \
  --url https://loyalty-admin.appstle.com/api/external/point-redeem-rules \
  --header 'X-API-Key: <x-api-key>'
import requests

url = "https://loyalty-admin.appstle.com/api/external/point-redeem-rules"

headers = {"X-API-Key": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};

fetch('https://loyalty-admin.appstle.com/api/external/point-redeem-rules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
const url = 'https://loyalty-admin.appstle.com/api/external/point-redeem-rules';
const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};

fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://loyalty-admin.appstle.com/api/external/point-redeem-rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <x-api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://loyalty-admin.appstle.com/api/external/point-redeem-rules"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-Key", "<x-api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
require 'uri'
require 'net/http'

url = URI("https://loyalty-admin.appstle.com/api/external/point-redeem-rules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'

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

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>