Sign in
latestOpenAPI 3.0.12026-07-21191548.4 KB

f62b6f66ee8f

Customer Enrollment & Profile

Get customer loyalty information

get/loyalty/cp/api/customer-loyalty

Query parameters

statusstring

Filter rewards by status (comma-separated values). Allowed values: UNUSED, USED, EXPIRED

Response

Customer loyalty information retrieved successfully

achievableTierIdinteger
availablePointsnumber double
createAtstring date-time
creditedPointsnumber double
currentVipTierstring
customerStatus'ACTIVE' | 'INACTIVE' | 'EXCLUDED' | 'EXCLUDED_BY_CUSTOMER'
dobstring date
expiringPointsAmountnumber double
pendingPointsnumber double
pointsExpireAtstring date-time
referralLinkstring
referredCompletedinteger
rewardedForCreatingAccountboolean
rewardedForFacebookboolean
rewardedForInstagramboolean
rewardedForNewsLetterboolean
rewardedForPinterestboolean
rewardedForSharingOnFacebookboolean
rewardedForSharingOnXboolean
rewardedForSmsboolean
rewardedForTiktokboolean
rewardedForTwitterboolean
rewardedForYoutubeboolean
spentAmountnumber double
storeCreditBalancenumber double
storeCreditCurrencystring
vipTierExpiredAtstring date-time
vipTierSpentAmountnumber double