Points & Earn Rules

Add store credits to customer account

post/api/external/add-credits

Headers

X-API-Keystring required

API key for authentication

creditsnumber double

customerEmailstring

customerIdinteger

earnRuleIdinteger

notestring

Store credits successfully added to customer account

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