Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://domain.com/services/data/v{{version}}/loyalty/programs/:loyaltyProgramName/members/:membershipNumber/transaction-ledger-summary",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "message": null,
; "status": true,
; "transactionJournalCount": 1,
; "transactionJournals": [
; {
; "activityDate": "2021-01-01T04:05:05.000Z",
; "additionalTransactionJournalAttributes": [
; ],
; "journalSubTypeName": "Member Enrollment",
; "journalTypeName": "Accrual",
; "pointsChange": [
; ],
; "transactionJournalId": "0lVJ8000000GmaEMAS",
; "transactionJournalNumber": "00000008"
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
activityDate.s
journalSubTypeName.s
journalTypeName.s
transactionJournalId.s
transactionJournalNumber.s
j.i
count_j.i
message.s = CkJsonObject::ckStringOf(jResp,"message")
status.i = CkJsonObject::ckBoolOf(jResp,"status")
transactionJournalCount.i = CkJsonObject::ckIntOf(jResp,"transactionJournalCount")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"transactionJournals")
While i < count_i
CkJsonObject::setCkI(jResp, i)
activityDate = CkJsonObject::ckStringOf(jResp,"transactionJournals[i].activityDate")
journalSubTypeName = CkJsonObject::ckStringOf(jResp,"transactionJournals[i].journalSubTypeName")
journalTypeName = CkJsonObject::ckStringOf(jResp,"transactionJournals[i].journalTypeName")
transactionJournalId = CkJsonObject::ckStringOf(jResp,"transactionJournals[i].transactionJournalId")
transactionJournalNumber = CkJsonObject::ckStringOf(jResp,"transactionJournals[i].transactionJournalNumber")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"transactionJournals[i].additionalTransactionJournalAttributes")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"transactionJournals[i].pointsChange")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/loyalty/programs/:loyaltyProgramName/members/:membershipNumber/transaction-ledger-summary
Postman Collection Item JSON
{
"name": "Transaction Ledger Summary",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
"/*",
"pm.variables.set('journalSubTypeName','journalSubTypeName');",
"pm.variables.set('additionalTransactionJournalAttributes','additionalTransactionJournalAttributes');",
"pm.variables.set('journalTypeName','journalTypeName');",
"pm.variables.set('pageNumber','pageNumber');",
"pm.variables.set('periodEndDate','periodEndDate');",
"pm.variables.set('periodStartDate','periodStartDate');",
"*/"
],
"type": "text/javascript",
"packages": {}
}
}
],
"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/:membershipNumber/transaction-ledger-summary",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"loyalty",
"programs",
":loyaltyProgramName",
"members",
":membershipNumber",
"transaction-ledger-summary"
],
"query": [
{
"key": "journalSubTypeName",
"value": "",
"description": "Returns the transaction journals filtered by the specified journal subtype.",
"disabled": true
},
{
"key": "additionalTransactionJournalAttributes",
"value": "",
"description": "Returns the list of transaction journal fields.",
"disabled": true
},
{
"key": "journalTypeName",
"value": "",
"description": "Returns the transaction journals filtered by the specified journal type.",
"disabled": true
},
{
"key": "pageNumber",
"value": "",
"description": "Returns the transaction journals for the specified page number.\n",
"disabled": true
},
{
"key": "periodEndDate",
"value": "",
"description": "Returns the transaction journals filtered by the specified end date.",
"disabled": true
},
{
"key": "periodStartDate",
"value": "",
"description": "Returns the transaction journals filtered by the specified start date.",
"disabled": true
}
],
"variable": [
{
"key": "loyaltyProgramName",
"value": ""
},
{
"key": "membershipNumber",
"value": ""
}
]
},
"description": "Standard Documentation:\n\n[https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_transaction_ledger.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_transaction_ledger.htm)"
},
"response": [
{
"name": "Transaction Ledger Summary",
"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/:membershipNumber/transaction-ledger-summary",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"loyalty",
"programs",
":loyaltyProgramName",
"members",
":membershipNumber",
"transaction-ledger-summary"
],
"query": [
{
"key": "journalSubTypeName",
"value": "",
"description": "Returns the transaction journals filtered by the specified journal subtype.",
"disabled": true
},
{
"key": "additionalTransactionJournalAttributes",
"value": "",
"description": "Returns the list of transaction journal fields.",
"disabled": true
},
{
"key": "journalTypeName",
"value": "",
"description": "Returns the transaction journals filtered by the specified journal type.",
"disabled": true
},
{
"key": "pageNumber",
"value": "",
"description": "Returns the transaction journals for the specified page number.\n",
"disabled": true
},
{
"key": "periodEndDate",
"value": "",
"description": "Returns the transaction journals filtered by the specified end date.",
"disabled": true
},
{
"key": "periodStartDate",
"value": "",
"description": "Returns the transaction journals filtered by the specified start date.",
"disabled": true
}
],
"variable": [
{
"key": "loyaltyProgramName",
"value": "NTO Insider"
},
{
"key": "membershipNumber",
"value": "Member123"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 27 May 2024 19:37:52 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 \"message\": null,\n \"status\": true,\n \"transactionJournalCount\": 1,\n \"transactionJournals\": [\n {\n \"activityDate\": \"2021-01-01T04:05:05.000Z\",\n \"additionalTransactionJournalAttributes\": [],\n \"journalSubTypeName\": \"Member Enrollment\",\n \"journalTypeName\": \"Accrual\",\n \"pointsChange\": [],\n \"transactionJournalId\": \"0lVJ8000000GmaEMAS\",\n \"transactionJournalNumber\": \"00000008\"\n }\n ]\n}"
}
]
}
