Skip to main content
GET
Get customer loyalty details

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

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