Chilkat Online Tools

phpExt / Salesforce Platform APIs / Redeem Voucher

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new 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.

// {
//   "currencyIsoCode": "EUR",
//   "redeemAmount": 1.5
// }

$json = new CkJsonObject();
$json->UpdateString('currencyIsoCode','EUR');
$json->UpdateNumber('redeemAmount','1.5');

// 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}}/loyalty/programs/:loyaltyProgramName/members/:membershipNumber/vouchers/:voucherCode/redeem?voucherNumber=','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->header() . "\n";
    print 'Failed.' . "\n";

    exit;
}

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

// {
//   "currencyIsoCode": "EUR",
//   "remainingAmount": 3.5
// }

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

$currencyIsoCode = $jResp->stringOf('currencyIsoCode');
$remainingAmount = $jResp->stringOf('remainingAmount');

?>

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
   "currencyIsoCode" : "EUR",
   "redeemAmount" : 1.5
}'
https://domain.com/services/data/v{{version}}/loyalty/programs/:loyaltyProgramName/members/:membershipNumber/vouchers/:voucherCode/redeem?voucherNumber=

Postman Collection Item JSON

{
  "name": "Redeem Voucher",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n   \"currencyIsoCode\" : \"EUR\",\n   \"redeemAmount\" : 1.5\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/loyalty/programs/:loyaltyProgramName/members/:membershipNumber/vouchers/:voucherCode/redeem?voucherNumber=",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "loyalty",
        "programs",
        ":loyaltyProgramName",
        "members",
        ":membershipNumber",
        "vouchers",
        ":voucherCode",
        "redeem"
      ],
      "query": [
        {
          "key": "voucherNumber",
          "value": ""
        }
      ],
      "variable": [
        {
          "key": "loyaltyProgramName",
          "value": "",
          "description": "The loyalty program name."
        },
        {
          "key": "membershipNumber",
          "value": "",
          "description": "The loyalty program membership number."
        },
        {
          "key": "voucherCode",
          "value": "",
          "description": "The voucher code to be redeemed."
        }
      ]
    },
    "description": "Standard Documentation:\n\n[https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_redeem_voucher.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_redeem_voucher.htm)"
  },
  "response": [
    {
      "name": "Redeem Voucher",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Authorization",
            "value": "Bearer {{accessToken}}"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n   \"currencyIsoCode\" : \"EUR\",\n   \"redeemAmount\" : 1.5\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/loyalty/programs/:loyaltyProgramName/members/:membershipNumber/vouchers/:voucherCode/redeem?voucherNumber=00000018",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "loyalty",
            "programs",
            ":loyaltyProgramName",
            "members",
            ":membershipNumber",
            "vouchers",
            ":voucherCode",
            "redeem"
          ],
          "query": [
            {
              "key": "voucherNumber",
              "value": "00000018"
            }
          ],
          "variable": [
            {
              "key": "loyaltyProgramName",
              "value": "NTO Insider",
              "description": "The loyalty program name."
            },
            {
              "key": "membershipNumber",
              "value": "Member123",
              "description": "The loyalty program membership number."
            },
            {
              "key": "voucherCode",
              "value": "44KYEWZ5",
              "description": "The voucher code to be redeemed."
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 27 May 2024 19:35:17 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    \"currencyIsoCode\": \"EUR\",\n    \"remainingAmount\": 3.5\n}"
    }
  ]
}