Chilkat Online Tools

Delphi (ActiveX) / Salesforce Platform APIs / Promotions Creation

Back to Collection Items

var

begin
json.UpdateString('name','Free Beverage');json.UpdateString('startDateTime','2023-06-30T00:00:00.000Z');json.UpdateString('displayName','Free Beverage');json.UpdateInt('priorityNumber',1);json.UpdateString('description','Buy 2 Get 1 free');json.UpdateString('endDateTime','2023-12-30T00:00:00.000Z');json.UpdateString('objective','To increase sales');json.UpdateString('loyaltyProgram.name','Program-001');json.UpdateString('additionalFieldValues.attributes.promotionLocation__c','HYD');json.UpdateInt('promotionLimits.perLineItemLimit',10);json.UpdateInt('promotionLimits.vouchersLimit',100);json.UpdateInt('promotionLimits.vouchersPerCustomerLimit',5);json.UpdateInt('promotionLimits.perCartLimit',5);json.UpdateInt('promotionLimits.usePerCustomerLimit',5);json.UpdateInt('promotionLimits.liabilityLimit',10000);json.UpdateString('promotionLimits.loyaltyProgramCurrency.id','0lcSB00000001TxYAI');json.UpdateInt('promotionLimits.pointsPerCustomerLimit',5);json.UpdateString('promotionEligibility.eligibleProductCategories[0].id','0ZGSB0000002td74AA');json.UpdateString('promotionEligibility.eligibleProducts[0].name','Coke');json.UpdateString('promotionEligibility.eligibleChannels[0].channelType','Offline');json.UpdateString('promotionEligibility.eligibleChannels[0].store.name','test Store');json.UpdateString('promotionEligibility.eligibleChannels[0].retailLocationGroup.name','test');json.UpdateString('promotionEligibility.eligibleCustomerEvents.event','MemberBirthday');json.UpdateString('promotionEligibility.eligibleCustomerEvents.eventPeriodUnit','Date');json.UpdateBool('promotionEligibility.eligibleEnrollmentPeriod.isEnrollmentRequired',1);json.UpdateString('promotionEligibility.eligibleEnrollmentPeriod.enrollmentStartDate','2023-06-30T00:00:00.000Z');json.UpdateString('promotionEligibility.eligibleEnrollmentPeriod.enrollmentEndDate','2023-12-30T00:00:00.000Z');json.UpdateString('promotionEligibility.eligibleLoyaltyTiers[0].tierGroup.name','Group-001');json.UpdateString('promotionEligibility.eligibleLoyaltyTiers[0].tierGroup.id','0ltSB00000000T3YAI');json.UpdateString('promotionEligibility.eligibleLoyaltyTiers[0].tier.name','Silver');json.UpdateString('promotionEligibility.eligibleLoyaltyTiers[0].tier.id','0lgSB00000000srYAA');http.AuthToken := '<access_token>';success := http.HttpJson('POST','https://domain.com/services/data/v{{version}}/global-promotions-management/promotions',json.ControlInterface,'application/json',resp.ControlInterface);

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
   "name":"Free Beverage",
   "startDateTime":"2023-06-30T00:00:00.000Z",
   "displayName":"Free Beverage",
   "priorityNumber":1,
   "description":"Buy 2 Get 1 free",
   "endDateTime":"2023-12-30T00:00:00.000Z",
   "objective":"To increase sales",
   "loyaltyProgram":{
      "name":"Program-001"
   },
   "additionalFieldValues":{
      "attributes":{
         "promotionLocation__c":"HYD"
      }
   },
   "promotionLimits":{
      "perLineItemLimit":10,
      "vouchersLimit":100,
      "vouchersPerCustomerLimit":5,
      "perCartLimit":5,
      "usePerCustomerLimit":5,
      "liabilityLimit":10000,
      "loyaltyProgramCurrency":{
         "id":"0lcSB00000001TxYAI"
      },
      "pointsPerCustomerLimit":5
   },
   "promotionEligibility":{
      "eligibleProductCategories":[
         {
            "id":"0ZGSB0000002td74AA"
         }
      ],
      "eligibleProducts":[
         {
            "name":"Coke"
         }
      ],
      "eligibleChannels":[
         {
            "channelType":"Offline",
            "store":{
               "name":"test Store"
            },
            "retailLocationGroup":{
               "name":"test"
            }
         }
      ],
      "eligibleCustomerEvents":{
         "event":"MemberBirthday",
         "eventPeriodUnit":"Date"
      },
      "eligibleEnrollmentPeriod":{
         "isEnrollmentRequired":true,
         "enrollmentStartDate":"2023-06-30T00:00:00.000Z",
         "enrollmentEndDate":"2023-12-30T00:00:00.000Z"
      },
      "eligibleLoyaltyTiers":[
         {
            "tierGroup":{
               "name":"Group-001",
               "id":"0ltSB00000000T3YAI"
            },
            "tier":{
               "name":"Silver",
               "id":"0lgSB00000000srYAA"
            }
         }
      ]
   }
}'
https://domain.com/services/data/v{{version}}/global-promotions-management/promotions

Postman Collection Item JSON

{
  "name": "Promotions Creation",
  "event": [
    {
      "listen": "prerequest",
      "script": {
        "exec": [
          "//pm.variables.set('loyaltyProgramName','xyz');",
          "pm.variables.set('processName','TierProcessing');"
        ],
        "type": "text/javascript",
        "packages": {}
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n   \"name\":\"Free Beverage\",\n   \"startDateTime\":\"2023-06-30T00:00:00.000Z\",\n   \"displayName\":\"Free Beverage\",\n   \"priorityNumber\":1,\n   \"description\":\"Buy 2 Get 1 free\",\n   \"endDateTime\":\"2023-12-30T00:00:00.000Z\",\n   \"objective\":\"To increase sales\",\n   \"loyaltyProgram\":{\n      \"name\":\"Program-001\"\n   },\n   \"additionalFieldValues\":{\n      \"attributes\":{\n         \"promotionLocation__c\":\"HYD\"\n      }\n   },\n   \"promotionLimits\":{\n      \"perLineItemLimit\":10,\n      \"vouchersLimit\":100,\n      \"vouchersPerCustomerLimit\":5,\n      \"perCartLimit\":5,\n      \"usePerCustomerLimit\":5,\n      \"liabilityLimit\":10000,\n      \"loyaltyProgramCurrency\":{\n         \"id\":\"0lcSB00000001TxYAI\"\n      },\n      \"pointsPerCustomerLimit\":5\n   },\n   \"promotionEligibility\":{\n      \"eligibleProductCategories\":[\n         {\n            \"id\":\"0ZGSB0000002td74AA\"\n         }\n      ],\n      \"eligibleProducts\":[\n         {\n            \"name\":\"Coke\"\n         }\n      ],\n      \"eligibleChannels\":[\n         {\n            \"channelType\":\"Offline\",\n            \"store\":{\n               \"name\":\"test Store\"\n            },\n            \"retailLocationGroup\":{\n               \"name\":\"test\"\n            }\n         }\n      ],\n      \"eligibleCustomerEvents\":{\n         \"event\":\"MemberBirthday\",\n         \"eventPeriodUnit\":\"Date\"\n      },\n      \"eligibleEnrollmentPeriod\":{\n         \"isEnrollmentRequired\":true,\n         \"enrollmentStartDate\":\"2023-06-30T00:00:00.000Z\",\n         \"enrollmentEndDate\":\"2023-12-30T00:00:00.000Z\"\n      },\n      \"eligibleLoyaltyTiers\":[\n         {\n            \"tierGroup\":{\n               \"name\":\"Group-001\",\n               \"id\":\"0ltSB00000000T3YAI\"\n            },\n            \"tier\":{\n               \"name\":\"Silver\",\n               \"id\":\"0lgSB00000000srYAA\"\n            }\n         }\n      ]\n   }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/global-promotions-management/promotions",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "global-promotions-management",
        "promotions"
      ],
      "query": [
        {
          "key": "journalTypeId",
          "value": "",
          "disabled": true
        }
      ]
    },
    "description": "[Promotions Creation](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_unified_promotions.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": [
  ]
}