Chilkat Online Tools

Ruby / Salesforce Platform APIs / Transaction Journals Execution

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

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

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/services/data/v{{version}}/connect/realtime/loyalty/programs/:loyaltyProgramName","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

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": [
  ]
}