Skip to main content
GET
/
api
/
external
/
customer-loyalty
Get customer loyalty details
curl --request GET \
  --url https://loyalty-admin.appstle.com/api/external/customer-loyalty \
  --header 'X-API-Key: <x-api-key>'
{
  "availablePoints": 250,
  "pendingPoints": 50,
  "creditedPoints": 500,
  "spentAmount": 1250.99,
  "storeCreditBalance": 25,
  "currentVipTier": "Gold",
  "vipTierExpiredAt": "2025-12-31T23:59:59Z",
  "achievableTierId": 2,
  "createAt": "2024-01-15T10:00:00Z",
  "rewardedForFacebook": true,
  "rewardedForInstagram": false,
  "rewardedForTwitter": false,
  "rewardedForPinterest": false,
  "rewardedForYoutube": false,
  "rewardedForTiktok": false,
  "rewardedForNewsLetter": true,
  "rewardedForSms": false,
  "rewardedForCreatingAccount": true,
  "rewardedForSharingOnFacebook": false,
  "rewardedForSharingOnX": false,
  "referredCompleted": 3,
  "referralLink": "https://yourstore.com/r/abc123",
  "customerStatus": "ACTIVE",
  "dob": "1990-05-15",
  "rewards": [
    {
      "id": 12345,
      "discountCode": "LOYALTY10OFF",
      "discountType": "PERCENTAGE",
      "discountValue": 10,
      "status": "UNUSED",
      "expiryDate": "2025-06-30T23:59:59Z",
      "pointsRedeemed": 100
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developers.appstle.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

X-API-Key
string
required

API key for authentication

Query Parameters

customerId
integer<int64>

Shopify customer ID (optional if customerEmail provided)

customerEmail
string

Customer email address (optional if customerId provided)

status
string

Filter rewards by status (comma-separated: ACTIVE, USED, UNUSED)

Response

Successfully retrieved customer loyalty details

availablePoints
number<double>
pendingPoints
number<double>
creditedPoints
number<double>
spentAmount
number<double>
storeCreditBalance
number<double>
achievableTierId
integer<int64>
currentVipTier
string
vipTierExpiredAt
string<date-time>
createAt
string<date-time>
rewardedForFacebook
boolean
rewardedForPinterest
boolean
rewardedForTwitter
boolean
rewardedForInstagram
boolean
rewardedForYoutube
boolean
rewardedForTiktok
boolean
rewardedForNewsLetter
boolean
rewardedForSms
boolean
referredCompleted
integer<int64>
customerStatus
enum<string>
Available options:
ACTIVE,
INACTIVE,
EXCLUDED,
EXCLUDED_BY_CUSTOMER
dob
string<date>
rewards
object[]
rewardedForCreatingAccount
boolean
rewardedForSharingOnFacebook
boolean
rewardedForSharingOnX
boolean
expiringPointsAmount
number<double>
pointsExpireAt
string<date-time>