v1

latestOpenAPI 3.0.12026-07-21161785.3 KB

Customer Enrollment & Profile

Get customer loyalty details

get/api/external/customer-loyalty

customerIdinteger

Shopify customer ID (optional if customerEmail provided)

customerEmailstring

Customer email address (optional if customerId provided)

statusstring

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

X-API-Keystring required

API key for authentication

Successfully retrieved customer loyalty details

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