Chilkat Online Tools

lianja / Salesforce Platform APIs / Debit Points from Members

Back to Collection Items

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

loHttp = createobject("CkHttp")

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

// The following JSON is sent in the request body.

// {
//   "processParameters": [
//     {
//       "TransactionJournal": {
//         "ActivityDate": "2023-08-27T00:00:00Z",
//         "ExternalTransactionNumber": "1",
//         "InvoiceDate": "2023-08-23",
//         "JournalTypeName": "Redemption",
//         "MembershipNumber": "Member123",
//         "TransactionAmount": "45.0",
//         "CurrencyIsoCode": "EUR",
//         "Status": "Processed"
//       },
//       "PointsToDebit": 6.0
//     }
//   ]
// }

loJson = createobject("CkJsonObject")
loJson.UpdateString("processParameters[0].TransactionJournal.ActivityDate","2023-08-27T00:00:00Z")
loJson.UpdateString("processParameters[0].TransactionJournal.ExternalTransactionNumber","1")
loJson.UpdateString("processParameters[0].TransactionJournal.InvoiceDate","2023-08-23")
loJson.UpdateString("processParameters[0].TransactionJournal.JournalTypeName","Redemption")
loJson.UpdateString("processParameters[0].TransactionJournal.MembershipNumber","Member123")
loJson.UpdateString("processParameters[0].TransactionJournal.TransactionAmount","45.0")
loJson.UpdateString("processParameters[0].TransactionJournal.CurrencyIsoCode","EUR")
loJson.UpdateString("processParameters[0].TransactionJournal.Status","Processed")
loJson.UpdateNumber("processParameters[0].PointsToDebit","6.0")

// 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/program-processes/:processName","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "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
    return
endif

release loResp

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

// {
//   "message": null,
//   "outputParameters": {
//     "outputParameters": {
//       "results": [
//         {
//           "PointsDebited": 6
//         }
//       ]
//     }
//   },
//   "simulationDetails": {},
//   "status": true
// }

// 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")
llStatus = loJResp.BoolOf("status")
i = 0
lnCount_i = loJResp.SizeOfArray("outputParameters.outputParameters.results")
do while i < lnCount_i
    loJResp.I = i
    lnPointsDebited = loJResp.IntOf("outputParameters.outputParameters.results[i].PointsDebited")
    i = i + 1
enddo


release loHttp
release loJson
release loSbResponseBody
release loJResp

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
  "processParameters": [
    {
      "TransactionJournal": {
        "ActivityDate": "2023-08-27T00:00:00Z",
        "ExternalTransactionNumber": "1",
        "InvoiceDate": "2023-08-23",
        "JournalTypeName": "Redemption",
        "MembershipNumber":"Member123",
        "TransactionAmount": "45.0",
        "CurrencyIsoCode":"EUR",
        "Status":"Processed"
      },
      "PointsToDebit": 6.0
    }
  ]
}'
https://domain.com/services/data/v{{version}}/connect/loyalty/programs/:loyaltyProgramName/program-processes/:processName

Postman Collection Item JSON

{
  "name": "Debit Points from Members",
  "event": [
    {
      "listen": "prerequest",
      "script": {
        "exec": [
          "//pm.variables.set('loyaltyProgramName','xyz');",
          "pm.variables.set('processName','DebitPointsFromMembers');"
        ],
        "type": "text/javascript",
        "packages": {}
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"processParameters\": [\n    {\n      \"TransactionJournal\": {\n        \"ActivityDate\": \"2023-08-27T00:00:00Z\",\n        \"ExternalTransactionNumber\": \"1\",\n        \"InvoiceDate\": \"2023-08-23\",\n        \"JournalTypeName\": \"Redemption\",\n        \"MembershipNumber\":\"Member123\",\n        \"TransactionAmount\": \"45.0\",\n        \"CurrencyIsoCode\":\"EUR\",\n        \"Status\":\"Processed\"\n      },\n      \"PointsToDebit\": 6.0\n    }\n  ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/connect/loyalty/programs/:loyaltyProgramName/program-processes/:processName",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "connect",
        "loyalty",
        "programs",
        ":loyaltyProgramName",
        "program-processes",
        ":processName"
      ],
      "query": [
        {
          "key": "journalTypeId",
          "value": "",
          "disabled": true
        }
      ],
      "variable": [
        {
          "key": "loyaltyProgramName",
          "value": ""
        },
        {
          "key": "processName",
          "value": ""
        }
      ]
    },
    "description": "[Debit Points from Members](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_debit_points_from_members.htm)\n\nNOTE:\n\nIn the Pre-request. Script Tab, make changes in the variables value accordingly with the real Process Name to invoke."
  },
  "response": [
    {
      "name": "Debit Points from Members",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Authorization",
            "value": "Bearer {{accessToken}}"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"processParameters\": [\n    {\n      \"TransactionJournal\": {\n        \"ActivityDate\": \"2023-08-27T00:00:00Z\",\n        \"ExternalTransactionNumber\": \"1\",\n        \"InvoiceDate\": \"2023-08-23\",\n        \"JournalTypeName\": \"Redemption\",\n        \"MembershipNumber\":\"Member123\",\n        \"TransactionAmount\": \"45.0\",\n        \"CurrencyIsoCode\":\"EUR\",\n        \"Status\":\"Processed\"\n      },\n      \"PointsToDebit\": 6.0\n    }\n  ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/connect/loyalty/programs/:loyaltyProgramName/program-processes/:processName",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "loyalty",
            "programs",
            ":loyaltyProgramName",
            "program-processes",
            ":processName"
          ],
          "query": [
            {
              "key": "journalTypeId",
              "value": null,
              "disabled": true
            }
          ],
          "variable": [
            {
              "key": "loyaltyProgramName",
              "value": "NTO Insider"
            },
            {
              "key": "processName",
              "value": "debitPoints"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 27 May 2024 20:21:45 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    \"outputParameters\": {\n        \"outputParameters\": {\n            \"results\": [\n                {\n                    \"PointsDebited\": 6\n                }\n            ]\n        }\n    },\n    \"simulationDetails\": {},\n    \"status\": true\n}"
    }
  ]
}