Chilkat Online Tools

PureBasic / Salesforce Platform APIs / Transaction Journals Execution

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.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

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

    ; The following JSON is sent in the request body.

    ; {
    ;   "transactionJournals": [
    ;     {
    ;       "ActivityDate": "2023-11-27T12:45:19Z",
    ;       "JournalTypeId": "0lERM00000001Bb2AI",
    ;       "LoyaltyProgramId": "0lpRM00000002YTYAY",
    ;       "MemberId": "0lMRM0000002Fmu2AE",
    ;       "Status": "Pending",
    ;       "appliedPromotions": [
    ;         {
    ;           "promotionId": "0c8RM0000004FiXYAU",
    ;           "rewards": [
    ;             {
    ;               "rewardType": "Discount",
    ;               "discountAmount": 15
    ;             },
    ;             {
    ;               "rewardType": "Points",
    ;               "loyaltyProgramCurrencyName": "Coins",
    ;               "points": 100,
    ;               "relatedInformation": "Test",
    ;               "notes": "Test"
    ;             },
    ;             {
    ;               "rewardType": "Voucher",
    ;               "voucherDefinitionName": "10% Discount Voucher",
    ;               "voucherExpirationDate": "2023-12-15",
    ;               "voucherEffectiveDate": "2023-11-29",
    ;               "notes": "Test"
    ;             },
    ;             {
    ;               "rewardType": "Badge",
    ;               "loyaltyProgramBadgeName": "Gen AI Badge",
    ;               "memberBadgeStatus": "Active",
    ;               "badgeValidityEndDate": "2023-12-15",
    ;               "reason": "Test"
    ;             },
    ;             {
    ;               "rewardType": "Game",
    ;               "gameDefinitionName": "TestGame"
    ;             }
    ;           ]
    ;         }
    ;       ]
    ;     }
    ;   ]
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"transactionJournals[0].ActivityDate","2023-11-27T12:45:19Z")
    CkJsonObject::ckUpdateString(json,"transactionJournals[0].JournalTypeId","0lERM00000001Bb2AI")
    CkJsonObject::ckUpdateString(json,"transactionJournals[0].LoyaltyProgramId","0lpRM00000002YTYAY")
    CkJsonObject::ckUpdateString(json,"transactionJournals[0].MemberId","0lMRM0000002Fmu2AE")
    CkJsonObject::ckUpdateString(json,"transactionJournals[0].Status","Pending")
    CkJsonObject::ckUpdateString(json,"transactionJournals[0].appliedPromotions[0].promotionId","0c8RM0000004FiXYAU")
    CkJsonObject::ckUpdateString(json,"transactionJournals[0].appliedPromotions[0].rewards[0].rewardType","Discount")
    CkJsonObject::ckUpdateInt(json,"transactionJournals[0].appliedPromotions[0].rewards[0].discountAmount",15)
    CkJsonObject::ckUpdateString(json,"transactionJournals[0].appliedPromotions[0].rewards[1].rewardType","Points")
    CkJsonObject::ckUpdateString(json,"transactionJournals[0].appliedPromotions[0].rewards[1].loyaltyProgramCurrencyName","Coins")
    CkJsonObject::ckUpdateInt(json,"transactionJournals[0].appliedPromotions[0].rewards[1].points",100)
    CkJsonObject::ckUpdateString(json,"transactionJournals[0].appliedPromotions[0].rewards[1].relatedInformation","Test")
    CkJsonObject::ckUpdateString(json,"transactionJournals[0].appliedPromotions[0].rewards[1].notes","Test")
    CkJsonObject::ckUpdateString(json,"transactionJournals[0].appliedPromotions[0].rewards[2].rewardType","Voucher")
    CkJsonObject::ckUpdateString(json,"transactionJournals[0].appliedPromotions[0].rewards[2].voucherDefinitionName","10% Discount Voucher")
    CkJsonObject::ckUpdateString(json,"transactionJournals[0].appliedPromotions[0].rewards[2].voucherExpirationDate","2023-12-15")
    CkJsonObject::ckUpdateString(json,"transactionJournals[0].appliedPromotions[0].rewards[2].voucherEffectiveDate","2023-11-29")
    CkJsonObject::ckUpdateString(json,"transactionJournals[0].appliedPromotions[0].rewards[2].notes","Test")
    CkJsonObject::ckUpdateString(json,"transactionJournals[0].appliedPromotions[0].rewards[3].rewardType","Badge")
    CkJsonObject::ckUpdateString(json,"transactionJournals[0].appliedPromotions[0].rewards[3].loyaltyProgramBadgeName","Gen AI Badge")
    CkJsonObject::ckUpdateString(json,"transactionJournals[0].appliedPromotions[0].rewards[3].memberBadgeStatus","Active")
    CkJsonObject::ckUpdateString(json,"transactionJournals[0].appliedPromotions[0].rewards[3].badgeValidityEndDate","2023-12-15")
    CkJsonObject::ckUpdateString(json,"transactionJournals[0].appliedPromotions[0].rewards[3].reason","Test")
    CkJsonObject::ckUpdateString(json,"transactionJournals[0].appliedPromotions[0].rewards[4].rewardType","Game")
    CkJsonObject::ckUpdateString(json,"transactionJournals[0].appliedPromotions[0].rewards[4].gameDefinitionName","TestGame")

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")

    resp.i = CkHttpResponse::ckCreate()
    If resp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckHttpJson(http,"POST","https://domain.com/services/data/v{{version}}/connect/realtime/loyalty/programs/:loyaltyProgramName",json,"application/json",resp)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkHttpResponse::ckDispose(resp)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkHttpResponse::ckDispose(resp)


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
   "transactionJournals":[
      {
         "ActivityDate":"2023-11-27T12:45:19Z",
         "JournalTypeId":"0lERM00000001Bb2AI",
         "LoyaltyProgramId":"0lpRM00000002YTYAY",
         "MemberId":"0lMRM0000002Fmu2AE",
         "Status":"Pending",
         "appliedPromotions":[
            {
               "promotionId":"0c8RM0000004FiXYAU",
               "rewards":[
                  {
                     "rewardType":"Discount",
                     "discountAmount":15
                  },
                  {
                     "rewardType":"Points",
                     "loyaltyProgramCurrencyName":"Coins",
                     "points":100,
                     "relatedInformation":"Test",
                     "notes":"Test"
                  },
                  {
                     "rewardType":"Voucher",
                     "voucherDefinitionName":"10% Discount Voucher",
                     "voucherExpirationDate":"2023-12-15",
                     "voucherEffectiveDate":"2023-11-29",
                     "notes":"Test"
                  },
                  {
                     "rewardType":"Badge",
                     "loyaltyProgramBadgeName":"Gen AI Badge",
                     "memberBadgeStatus":"Active",
                     "badgeValidityEndDate":"2023-12-15",
                     "reason":"Test"
                  },
                  {
                     "rewardType":"Game",
                     "gameDefinitionName":"TestGame"
                  }
               ]
            }
         ]
      }
   ]
}'
https://domain.com/services/data/v{{version}}/connect/realtime/loyalty/programs/:loyaltyProgramName

Postman Collection Item JSON

{
  "name": "Transaction Journals Execution",
  "event": [
    {
      "listen": "prerequest",
      "script": {
        "exec": [
          "var moment = require('moment');",
          "pm.globals.set('currentDatetime', moment().format((\"YYYY-MM-DDTHH:MM:SS\")));"
        ],
        "type": "text/javascript",
        "packages": {}
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n   \"transactionJournals\":[\n      {\n         \"ActivityDate\":\"2023-11-27T12:45:19Z\",\n         \"JournalTypeId\":\"0lERM00000001Bb2AI\",\n         \"LoyaltyProgramId\":\"0lpRM00000002YTYAY\",\n         \"MemberId\":\"0lMRM0000002Fmu2AE\",\n         \"Status\":\"Pending\",\n         \"appliedPromotions\":[\n            {\n               \"promotionId\":\"0c8RM0000004FiXYAU\",\n               \"rewards\":[\n                  {\n                     \"rewardType\":\"Discount\",\n                     \"discountAmount\":15\n                  },\n                  {\n                     \"rewardType\":\"Points\",\n                     \"loyaltyProgramCurrencyName\":\"Coins\",\n                     \"points\":100,\n                     \"relatedInformation\":\"Test\",\n                     \"notes\":\"Test\"\n                  },\n                  {\n                     \"rewardType\":\"Voucher\",\n                     \"voucherDefinitionName\":\"10% Discount Voucher\",\n                     \"voucherExpirationDate\":\"2023-12-15\",\n                     \"voucherEffectiveDate\":\"2023-11-29\",\n                     \"notes\":\"Test\"\n                  },\n                  {\n                     \"rewardType\":\"Badge\",\n                     \"loyaltyProgramBadgeName\":\"Gen AI Badge\",\n                     \"memberBadgeStatus\":\"Active\",\n                     \"badgeValidityEndDate\":\"2023-12-15\",\n                     \"reason\":\"Test\"\n                  },\n                  {\n                     \"rewardType\":\"Game\",\n                     \"gameDefinitionName\":\"TestGame\"\n                  }\n               ]\n            }\n         ]\n      }\n   ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/connect/realtime/loyalty/programs/:loyaltyProgramName",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "connect",
        "realtime",
        "loyalty",
        "programs",
        ":loyaltyProgramName"
      ],
      "variable": [
        {
          "key": "loyaltyProgramName",
          "value": ""
        }
      ]
    },
    "description": "Standard Documentation:\n\n[https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_loyalty_program_realtime.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_loyalty_program_realtime.htm)"
  },
  "response": [
  ]
}