Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("memberId","")
$oQueryParams.UpdateString("membershipNumber","")
$oQueryParams.UpdateString("programCurrencyName","")
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
Local $oResp = $oHttp.QuickRequestParams("GET","https://domain.com/services/data/v{{version}}/loyalty-programs/:loyaltyProgramName/members",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "additionalLoyaltyProgramMemberFields": {},
; "associatedAccount": null,
; "associatedContact": {
; "contactId": "003J8000002Yu0ZIAS",
; "email": "ab@email.com",
; "firstName": "Name1",
; "lastName": "Name2"
; },
; "canReceivePartnerPromotions": true,
; "canReceivePromotions": true,
; "enrollmentChannel": "Email",
; "enrollmentDate": "2021-01-01",
; "groupCreatedByMember": null,
; "groupName": null,
; "lastActivityDate": null,
; "loyaltyProgramMemberId": "0lMJ8000000CaRMMA0",
; "loyaltyProgramName": "NTO Insider",
; "memberCurrencies": [
; {
; "additionalLoyaltyMemberCurrencyFields": {
; "Level_Before_Reset__c": null
; },
; "escrowPointsBalance": 0,
; "expirablePoints": 0,
; "lastAccrualProcessedDate": null,
; "lastEscrowProcessedDate": null,
; "lastExpirationProcessRunDate": null,
; "lastPointsAggregationDate": null,
; "lastPointsResetDate": null,
; "loyaltyMemberCurrencyName": "NTO Qualifying Points",
; "loyaltyProgramCurrencyId": "0lcJ8000000CaR7IAK",
; "loyaltyProgramCurrencyName": null,
; "memberCurrencyId": "0lzJ8000000CaRMIA0",
; "nextQualifyingPointsResetDate": "2024-12-31",
; "pointsBalance": 0,
; "qualifyingPointsBalanceBeforeReset": 0,
; "totalEscrowPointsAccrued": 0,
; "totalEscrowRolloverPoints": 0,
; "totalPointsAccrued": 0,
; "totalPointsExpired": 0,
; "totalPointsRedeemed": 0
; }
; ],
; "memberStatus": "Active",
; "memberTiers": [
; {
; "additionalLoyaltyMemberTierFields": {},
; "areTierBenefitsAssigned": false,
; "loyaltyMemberTierId": "0lyJ8000000CaRMIA0",
; "loyaltyMemberTierName": "Bronze",
; "tierChangeReason": null,
; "tierChangeReasonType": null,
; "tierEffectiveDate": "2021-01-01",
; "tierExpirationDate": null,
; "tierGroupId": "0ltJ8000000CaR8IAK",
; "tierGroupName": null,
; "tierId": "0lgJ80000008OI5IAM",
; "tierSequenceNumber": 10
; }
; ],
; "memberType": "Individual",
; "membershipEndDate": "2022-01-01",
; "membershipLastRenewalDate": null,
; "membershipNumber": "Member1",
; "referredBy": null,
; "relatedCorporateMembershipNumber": null,
; "transactionJournalStatementFrequency": "Monthly",
; "transactionJournalStatementLastGeneratedDate": null,
; "transactionJournalStatementMethod": "Mail"
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sLevel_Before_Reset__c
Local $iEscrowPointsBalance
Local $iExpirablePoints
Local $sLastAccrualProcessedDate
Local $sLastEscrowProcessedDate
Local $sLastExpirationProcessRunDate
Local $sLastPointsAggregationDate
Local $sLastPointsResetDate
Local $sLoyaltyMemberCurrencyName
Local $sLoyaltyProgramCurrencyId
Local $sLoyaltyProgramCurrencyName
Local $sMemberCurrencyId
Local $sNextQualifyingPointsResetDate
Local $iPointsBalance
Local $iQualifyingPointsBalanceBeforeReset
Local $iTotalEscrowPointsAccrued
Local $iTotalEscrowRolloverPoints
Local $iTotalPointsAccrued
Local $iTotalPointsExpired
Local $iTotalPointsRedeemed
Local $bAreTierBenefitsAssigned
Local $sLoyaltyMemberTierId
Local $sLoyaltyMemberTierName
Local $sTierChangeReason
Local $sTierChangeReasonType
Local $sTierEffectiveDate
Local $sTierExpirationDate
Local $sTierGroupId
Local $sTierGroupName
Local $sTierId
Local $iTierSequenceNumber
Local $sAssociatedAccount = $oJResp.StringOf("associatedAccount")
Local $sContactId = $oJResp.StringOf("associatedContact.contactId")
Local $sV_Email = $oJResp.StringOf("associatedContact.email")
Local $sFirstName = $oJResp.StringOf("associatedContact.firstName")
Local $sLastName = $oJResp.StringOf("associatedContact.lastName")
Local $bCanReceivePartnerPromotions = $oJResp.BoolOf("canReceivePartnerPromotions")
Local $bCanReceivePromotions = $oJResp.BoolOf("canReceivePromotions")
Local $sEnrollmentChannel = $oJResp.StringOf("enrollmentChannel")
Local $sEnrollmentDate = $oJResp.StringOf("enrollmentDate")
Local $sGroupCreatedByMember = $oJResp.StringOf("groupCreatedByMember")
Local $sGroupName = $oJResp.StringOf("groupName")
Local $sLastActivityDate = $oJResp.StringOf("lastActivityDate")
Local $sLoyaltyProgramMemberId = $oJResp.StringOf("loyaltyProgramMemberId")
Local $sLoyaltyProgramName = $oJResp.StringOf("loyaltyProgramName")
Local $sMemberStatus = $oJResp.StringOf("memberStatus")
Local $sMemberType = $oJResp.StringOf("memberType")
Local $sMembershipEndDate = $oJResp.StringOf("membershipEndDate")
Local $sMembershipLastRenewalDate = $oJResp.StringOf("membershipLastRenewalDate")
Local $sMembershipNumber = $oJResp.StringOf("membershipNumber")
Local $sReferredBy = $oJResp.StringOf("referredBy")
Local $sRelatedCorporateMembershipNumber = $oJResp.StringOf("relatedCorporateMembershipNumber")
Local $sTransactionJournalStatementFrequency = $oJResp.StringOf("transactionJournalStatementFrequency")
Local $sTransactionJournalStatementLastGeneratedDate = $oJResp.StringOf("transactionJournalStatementLastGeneratedDate")
Local $sTransactionJournalStatementMethod = $oJResp.StringOf("transactionJournalStatementMethod")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("memberCurrencies")
While $i < $iCount_i
$oJResp.I = $i
$sLevel_Before_Reset__c = $oJResp.StringOf("memberCurrencies[i].additionalLoyaltyMemberCurrencyFields.Level_Before_Reset__c")
$iEscrowPointsBalance = $oJResp.IntOf("memberCurrencies[i].escrowPointsBalance")
$iExpirablePoints = $oJResp.IntOf("memberCurrencies[i].expirablePoints")
$sLastAccrualProcessedDate = $oJResp.StringOf("memberCurrencies[i].lastAccrualProcessedDate")
$sLastEscrowProcessedDate = $oJResp.StringOf("memberCurrencies[i].lastEscrowProcessedDate")
$sLastExpirationProcessRunDate = $oJResp.StringOf("memberCurrencies[i].lastExpirationProcessRunDate")
$sLastPointsAggregationDate = $oJResp.StringOf("memberCurrencies[i].lastPointsAggregationDate")
$sLastPointsResetDate = $oJResp.StringOf("memberCurrencies[i].lastPointsResetDate")
$sLoyaltyMemberCurrencyName = $oJResp.StringOf("memberCurrencies[i].loyaltyMemberCurrencyName")
$sLoyaltyProgramCurrencyId = $oJResp.StringOf("memberCurrencies[i].loyaltyProgramCurrencyId")
$sLoyaltyProgramCurrencyName = $oJResp.StringOf("memberCurrencies[i].loyaltyProgramCurrencyName")
$sMemberCurrencyId = $oJResp.StringOf("memberCurrencies[i].memberCurrencyId")
$sNextQualifyingPointsResetDate = $oJResp.StringOf("memberCurrencies[i].nextQualifyingPointsResetDate")
$iPointsBalance = $oJResp.IntOf("memberCurrencies[i].pointsBalance")
$iQualifyingPointsBalanceBeforeReset = $oJResp.IntOf("memberCurrencies[i].qualifyingPointsBalanceBeforeReset")
$iTotalEscrowPointsAccrued = $oJResp.IntOf("memberCurrencies[i].totalEscrowPointsAccrued")
$iTotalEscrowRolloverPoints = $oJResp.IntOf("memberCurrencies[i].totalEscrowRolloverPoints")
$iTotalPointsAccrued = $oJResp.IntOf("memberCurrencies[i].totalPointsAccrued")
$iTotalPointsExpired = $oJResp.IntOf("memberCurrencies[i].totalPointsExpired")
$iTotalPointsRedeemed = $oJResp.IntOf("memberCurrencies[i].totalPointsRedeemed")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("memberTiers")
While $i < $iCount_i
$oJResp.I = $i
$bAreTierBenefitsAssigned = $oJResp.BoolOf("memberTiers[i].areTierBenefitsAssigned")
$sLoyaltyMemberTierId = $oJResp.StringOf("memberTiers[i].loyaltyMemberTierId")
$sLoyaltyMemberTierName = $oJResp.StringOf("memberTiers[i].loyaltyMemberTierName")
$sTierChangeReason = $oJResp.StringOf("memberTiers[i].tierChangeReason")
$sTierChangeReasonType = $oJResp.StringOf("memberTiers[i].tierChangeReasonType")
$sTierEffectiveDate = $oJResp.StringOf("memberTiers[i].tierEffectiveDate")
$sTierExpirationDate = $oJResp.StringOf("memberTiers[i].tierExpirationDate")
$sTierGroupId = $oJResp.StringOf("memberTiers[i].tierGroupId")
$sTierGroupName = $oJResp.StringOf("memberTiers[i].tierGroupName")
$sTierId = $oJResp.StringOf("memberTiers[i].tierId")
$iTierSequenceNumber = $oJResp.IntOf("memberTiers[i].tierSequenceNumber")
$i = $i + 1
Wend
Curl Command
curl -G -d "memberId="
-d "membershipNumber="
-d "programCurrencyName="
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/loyalty-programs/:loyaltyProgramName/members
Postman Collection Item JSON
{
"name": "Member Profile",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/loyalty-programs/:loyaltyProgramName/members?memberId=&membershipNumber=&programCurrencyName=",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"loyalty-programs",
":loyaltyProgramName",
"members"
],
"query": [
{
"key": "memberId",
"value": "",
"description": "The ID of the loyalty program member."
},
{
"key": "membershipNumber",
"value": "",
"description": "The membership number of the loyalty program member."
},
{
"key": "programCurrencyName",
"value": "",
"description": "The name of the loyalty program currency associated with the member.\nUse this parameter to get the details of the member’s points-related information for a specific currency."
}
],
"variable": [
{
"key": "loyaltyProgramName",
"value": ""
}
]
},
"description": "Standard Documentation:\n\n[https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_member_profile.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_member_profile.htm)"
},
"response": [
{
"name": "Member Profile",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/loyalty-programs/:loyaltyProgramName/members?memberId=0lMJ8000000CaRMMA0&membershipNumber=Member1&programCurrencyName=NTO Qualifying Points",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"loyalty-programs",
":loyaltyProgramName",
"members"
],
"query": [
{
"key": "memberId",
"value": "0lMJ8000000CaRMMA0",
"description": "The ID of the loyalty program member."
},
{
"key": "membershipNumber",
"value": "Member1",
"description": "The membership number of the loyalty program member."
},
{
"key": "programCurrencyName",
"value": "NTO Qualifying Points",
"description": "The name of the loyalty program currency associated with the member.\nUse this parameter to get the details of the member’s points-related information for a specific currency."
}
],
"variable": [
{
"key": "loyaltyProgramName",
"value": "NTO Insider"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 22 May 2024 16:16:23 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"additionalLoyaltyProgramMemberFields\": {},\n \"associatedAccount\": null,\n \"associatedContact\": {\n \"contactId\": \"003J8000002Yu0ZIAS\",\n \"email\": \"ab@email.com\",\n \"firstName\": \"Name1\",\n \"lastName\": \"Name2\"\n },\n \"canReceivePartnerPromotions\": true,\n \"canReceivePromotions\": true,\n \"enrollmentChannel\": \"Email\",\n \"enrollmentDate\": \"2021-01-01\",\n \"groupCreatedByMember\": null,\n \"groupName\": null,\n \"lastActivityDate\": null,\n \"loyaltyProgramMemberId\": \"0lMJ8000000CaRMMA0\",\n \"loyaltyProgramName\": \"NTO Insider\",\n \"memberCurrencies\": [\n {\n \"additionalLoyaltyMemberCurrencyFields\": {\n \"Level_Before_Reset__c\": null\n },\n \"escrowPointsBalance\": 0,\n \"expirablePoints\": 0,\n \"lastAccrualProcessedDate\": null,\n \"lastEscrowProcessedDate\": null,\n \"lastExpirationProcessRunDate\": null,\n \"lastPointsAggregationDate\": null,\n \"lastPointsResetDate\": null,\n \"loyaltyMemberCurrencyName\": \"NTO Qualifying Points\",\n \"loyaltyProgramCurrencyId\": \"0lcJ8000000CaR7IAK\",\n \"loyaltyProgramCurrencyName\": null,\n \"memberCurrencyId\": \"0lzJ8000000CaRMIA0\",\n \"nextQualifyingPointsResetDate\": \"2024-12-31\",\n \"pointsBalance\": 0,\n \"qualifyingPointsBalanceBeforeReset\": 0,\n \"totalEscrowPointsAccrued\": 0,\n \"totalEscrowRolloverPoints\": 0,\n \"totalPointsAccrued\": 0,\n \"totalPointsExpired\": 0,\n \"totalPointsRedeemed\": 0\n }\n ],\n \"memberStatus\": \"Active\",\n \"memberTiers\": [\n {\n \"additionalLoyaltyMemberTierFields\": {},\n \"areTierBenefitsAssigned\": false,\n \"loyaltyMemberTierId\": \"0lyJ8000000CaRMIA0\",\n \"loyaltyMemberTierName\": \"Bronze\",\n \"tierChangeReason\": null,\n \"tierChangeReasonType\": null,\n \"tierEffectiveDate\": \"2021-01-01\",\n \"tierExpirationDate\": null,\n \"tierGroupId\": \"0ltJ8000000CaR8IAK\",\n \"tierGroupName\": null,\n \"tierId\": \"0lgJ80000008OI5IAM\",\n \"tierSequenceNumber\": 10\n }\n ],\n \"memberType\": \"Individual\",\n \"membershipEndDate\": \"2022-01-01\",\n \"membershipLastRenewalDate\": null,\n \"membershipNumber\": \"Member1\",\n \"referredBy\": null,\n \"relatedCorporateMembershipNumber\": null,\n \"transactionJournalStatementFrequency\": \"Monthly\",\n \"transactionJournalStatementLastGeneratedDate\": null,\n \"transactionJournalStatementMethod\": \"Mail\"\n}"
}
]
}
