Chilkat Online Tools

Foxpro / Salesforce Platform APIs / Transaction History

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcMessage
LOCAL lnStatus
LOCAL lnTotalCount
LOCAL i
LOCAL lnCount_i

* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* Use this online tool to generate code from sample JSON: Generate Code to Create JSON

* The following JSON is sent in the request body.

* {
*   "membershipNumber": "Member1",
*   "journalType": "Accrual",
*   "journalSubType": "Social",
*   "periodStartDate": "2022-01-27T00:00:00Z",
*   "periodEndDate": "2022-11-27T00:00:00Z"
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("membershipNumber","Member1")
loJson.UpdateString("journalType","Accrual")
loJson.UpdateString("journalSubType","Social")
loJson.UpdateString("periodStartDate","2022-01-27T00:00:00Z")
loJson.UpdateString("periodEndDate","2022-11-27T00:00:00Z")

* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"

loResp = loHttp.PostJson3("https://domain.com/services/data/v{{version}}/connect/loyalty/programs/:loyaltyProgramName/transaction-history?page=","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)

* {
*   "message": null,
*   "status": true,
*   "totalCount": 0,
*   "transactionJournals": [
*   ]
* }

* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

lcMessage = loJResp.StringOf("message")
lnStatus = loJResp.BoolOf("status")
lnTotalCount = loJResp.IntOf("totalCount")
i = 0
lnCount_i = loJResp.SizeOfArray("transactionJournals")
DO WHILE i < lnCount_i
    loJResp.I = i
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
   "membershipNumber":"Member1",
   "journalType":"Accrual",
   "journalSubType":"Social",
   "periodStartDate":"2022-01-27T00:00:00Z",
   "periodEndDate":"2022-11-27T00:00:00Z"
}'
https://domain.com/services/data/v{{version}}/connect/loyalty/programs/:loyaltyProgramName/transaction-history?page=

Postman Collection Item JSON

{
  "name": "Transaction History",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n   \"membershipNumber\":\"Member1\",\n   \"journalType\":\"Accrual\",\n   \"journalSubType\":\"Social\",\n   \"periodStartDate\":\"2022-01-27T00:00:00Z\",\n   \"periodEndDate\":\"2022-11-27T00:00:00Z\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/connect/loyalty/programs/:loyaltyProgramName/transaction-history?page=",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "connect",
        "loyalty",
        "programs",
        ":loyaltyProgramName",
        "transaction-history"
      ],
      "query": [
        {
          "key": "page",
          "value": ""
        }
      ],
      "variable": [
        {
          "key": "loyaltyProgramName",
          "value": ""
        }
      ]
    },
    "description": "Standard Documentation:\n\n[https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_transaction_history.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_transaction_history.htm)"
  },
  "response": [
    {
      "name": "Transaction History",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Authorization",
            "value": "Bearer {{accessToken}}"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n   \"membershipNumber\":\"Member1\",\n   \"journalType\":\"Accrual\",\n   \"journalSubType\":\"Social\",\n   \"periodStartDate\":\"2022-01-27T00:00:00Z\",\n   \"periodEndDate\":\"2022-11-27T00:00:00Z\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/connect/loyalty/programs/:loyaltyProgramName/transaction-history?page=2",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "loyalty",
            "programs",
            ":loyaltyProgramName",
            "transaction-history"
          ],
          "query": [
            {
              "key": "page",
              "value": "2"
            }
          ],
          "variable": [
            {
              "key": "loyaltyProgramName",
              "value": "NTO Insider"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 22 May 2024 16:22:05 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    \"totalCount\": 0,\n    \"transactionJournals\": []\n}"
    }
  ]
}