Chilkat Online Tools

delphiAx / ORACLE Hospitality OPERA Cloud REST API Workflows / Create a new Rate Plans

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
json: TChilkatJsonObject;
resp: IChilkatHttpResponse;

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

http := TChilkatHttp.Create(Self);

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

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

// {
//   "ratePlan": {
//     "primaryDetails": {
//       "description": {
//         "defaultText": "Rate Code Description Goes Here"
//       },
//       "startSellDate": "2021-01-03",
//       "endSellDate": "2021-12-31",
//       "privilegedRate": false,
//       "privilegedRateRestriction": false,
//       "lockStatus": "Unlocked"
//     },
//     "classifications": {
//       "rateCategory": "HOTEL",
//       "marketCode": "LEISURE"
//     },
//     "transactionDetails": {
//       "folioText": {
//         "defaultText": "Accommodation"
//       },
//       "transactionCode": "1000",
//       "currencyCode": "USD",
//       "rateIncludesTax": true
//     },
//     "rateCommission": {},
//     "roomTypeList": [
//       {
//         "code": "ECO"
//       },
//       {
//         "code": "SGL"
//       },
//       {
//         "code": "DBL"
//       },
//       {
//         "code": "SUP"
//       },
//       {
//         "code": "JSUI"
//       },
//       {
//         "code": "SUI"
//       }
//     ],
//     "ratePackages": {
//       "packages": [
//       ],
//       "packageGroups": [
//       ]
//     },
//     "controls": {
//       "sell": {
//         "minimumStayThrough": "1",
//         "minimumLengthOfStay": "1"
//       },
//       "yield": {
//         "yieldable": "NonYieldable"
//       }
//     },
//     "distribution": {
//       "restrictionUpdate": false,
//       "rateUpdate": false,
//       "myFidelioUploadAllowed": false,
//       "channelRateMappingExists": false,
//       "channelAllowed": false
//     },
//     "ratePlanBasedOnRates": [
//       {
//         "basedOnRatePlanType": "None"
//       }
//     ],
//     "approvalNotes": [
//       {}
//     ],
//     "mobileCheckinAllowed": false,
//     "mobileCheckoutAllowed": false,
//     "hotelId": "{{HotelId}}",
//     "ratePlanCode": "RACK123",
//     "supressRate": false,
//     "printRate": true,
//     "discountAllowed": false,
//     "redemption": false,
//     "bARRate": false,
//     "daily": false,
//     "tiered": false,
//     "dayUse": false,
//     "dayType": false,
//     "complimentary": false,
//     "houseUse": false,
//     "negotiated": false,
//     "ownerRate": false,
//     "membershipEligible": true,
//     "advancedDailyBase": false,
//     "advancedDailyRate": false
//   }
// }

json := TChilkatJsonObject.Create(Self);
json.UpdateString('ratePlan.primaryDetails.description.defaultText','Rate Code Description Goes Here');
json.UpdateString('ratePlan.primaryDetails.startSellDate','2021-01-03');
json.UpdateString('ratePlan.primaryDetails.endSellDate','2021-12-31');
json.UpdateBool('ratePlan.primaryDetails.privilegedRate',0);
json.UpdateBool('ratePlan.primaryDetails.privilegedRateRestriction',0);
json.UpdateString('ratePlan.primaryDetails.lockStatus','Unlocked');
json.UpdateString('ratePlan.classifications.rateCategory','HOTEL');
json.UpdateString('ratePlan.classifications.marketCode','LEISURE');
json.UpdateString('ratePlan.transactionDetails.folioText.defaultText','Accommodation');
json.UpdateString('ratePlan.transactionDetails.transactionCode','1000');
json.UpdateString('ratePlan.transactionDetails.currencyCode','USD');
json.UpdateBool('ratePlan.transactionDetails.rateIncludesTax',1);
json.UpdateNewObject('ratePlan.rateCommission');
json.UpdateString('ratePlan.roomTypeList[0].code','ECO');
json.UpdateString('ratePlan.roomTypeList[1].code','SGL');
json.UpdateString('ratePlan.roomTypeList[2].code','DBL');
json.UpdateString('ratePlan.roomTypeList[3].code','SUP');
json.UpdateString('ratePlan.roomTypeList[4].code','JSUI');
json.UpdateString('ratePlan.roomTypeList[5].code','SUI');
json.UpdateNewArray('ratePlan.ratePackages.packages');
json.UpdateNewArray('ratePlan.ratePackages.packageGroups');
json.UpdateString('ratePlan.controls.sell.minimumStayThrough','1');
json.UpdateString('ratePlan.controls.sell.minimumLengthOfStay','1');
json.UpdateString('ratePlan.controls.yield.yieldable','NonYieldable');
json.UpdateBool('ratePlan.distribution.restrictionUpdate',0);
json.UpdateBool('ratePlan.distribution.rateUpdate',0);
json.UpdateBool('ratePlan.distribution.myFidelioUploadAllowed',0);
json.UpdateBool('ratePlan.distribution.channelRateMappingExists',0);
json.UpdateBool('ratePlan.distribution.channelAllowed',0);
json.UpdateString('ratePlan.ratePlanBasedOnRates[0].basedOnRatePlanType','None');
json.UpdateBool('ratePlan.mobileCheckinAllowed',0);
json.UpdateBool('ratePlan.mobileCheckoutAllowed',0);
json.UpdateString('ratePlan.hotelId','{{HotelId}}');
json.UpdateString('ratePlan.ratePlanCode','RACK123');
json.UpdateBool('ratePlan.supressRate',0);
json.UpdateBool('ratePlan.printRate',1);
json.UpdateBool('ratePlan.discountAllowed',0);
json.UpdateBool('ratePlan.redemption',0);
json.UpdateBool('ratePlan.bARRate',0);
json.UpdateBool('ratePlan.daily',0);
json.UpdateBool('ratePlan.tiered',0);
json.UpdateBool('ratePlan.dayUse',0);
json.UpdateBool('ratePlan.dayType',0);
json.UpdateBool('ratePlan.complimentary',0);
json.UpdateBool('ratePlan.houseUse',0);
json.UpdateBool('ratePlan.negotiated',0);
json.UpdateBool('ratePlan.ownerRate',0);
json.UpdateBool('ratePlan.membershipEligible',1);
json.UpdateBool('ratePlan.advancedDailyBase',0);
json.UpdateBool('ratePlan.advancedDailyRate',0);

http.SetRequestHeader('Content-Type','application/json;charset=UTF-8');
http.SetRequestHeader('x-hotelid','{{HotelId}}');
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken := '<access_token>';
http.SetRequestHeader('Accept','application/json;charset=UTF-8');
http.SetRequestHeader('x-app-key','{{AppKey}}');

resp := http.PostJson3('https://domain.com/rtp/v0/hotels/{{HotelId}}/ratePlans','application/json;charset=UTF-8',json.ControlInterface);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

Memo1.Lines.Add(IntToStr(resp.StatusCode));
Memo1.Lines.Add(resp.BodyStr);

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json;charset=UTF-8"
	-H "Accept: application/json;charset=UTF-8"
	-H "x-hotelid: {{HotelId}}"
	-H "x-app-key: {{AppKey}}"
	-d '{
    "ratePlan": {
        "primaryDetails": {
            "description": {
                "defaultText": "Rate Code Description Goes Here"
            },
            "startSellDate": "2021-01-03",
            "endSellDate": "2021-12-31",
            "privilegedRate": false,
            "privilegedRateRestriction": false,
            "lockStatus": "Unlocked"
        },
        "classifications": {
            "rateCategory": "HOTEL",
            "marketCode": "LEISURE"
        },
        "transactionDetails": {
            "folioText": {
                "defaultText": "Accommodation"
            },
            "transactionCode": "1000",
            "currencyCode": "USD",
            "rateIncludesTax": true
        },
        "rateCommission": {},
        "roomTypeList": [
            {
                "code": "ECO"
            },
            {
                "code": "SGL"
            },
            {
                "code": "DBL"
            },
            {
                "code": "SUP"
            },
            {
                "code": "JSUI"
            },
            {
                "code": "SUI"
            }
        ],
        "ratePackages": {
            "packages": [],
            "packageGroups": []
        },
        "controls": {
            "sell": {
                "minimumStayThrough": "1",
                "minimumLengthOfStay": "1"
            },
            "yield": {
                "yieldable": "NonYieldable"
            }
        },
        "distribution": {
            "restrictionUpdate": false,
            "rateUpdate": false,
            "myFidelioUploadAllowed": false,
            "channelRateMappingExists": false,
            "channelAllowed": false
        },
        "ratePlanBasedOnRates": [
            {
                "basedOnRatePlanType": "None"
            }
        ],
        "approvalNotes": [
            {}
        ],
        "mobileCheckinAllowed": false,
        "mobileCheckoutAllowed": false,
        "hotelId": "{{HotelId}}",
        "ratePlanCode": "RACK123",
        "supressRate": false,
        "printRate": true,
        "discountAllowed": false,
        "redemption": false,
        "bARRate": false,
        "daily": false,
        "tiered": false,
        "dayUse": false,
        "dayType": false,
        "complimentary": false,
        "houseUse": false,
        "negotiated": false,
        "ownerRate": false,
        "membershipEligible": true,
        "advancedDailyBase": false,
        "advancedDailyRate": false
    }
}'
https://domain.com/rtp/v0/hotels/{{HotelId}}/ratePlans

Postman Collection Item JSON

{
  "name": "Create a new Rate Plans",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{Token}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "type": "text",
        "value": "application/json;charset=UTF-8"
      },
      {
        "key": "Accept",
        "type": "text",
        "value": "application/json;charset=UTF-8"
      },
      {
        "key": "x-hotelid",
        "type": "text",
        "value": "{{HotelId}}"
      },
      {
        "key": "x-app-key",
        "type": "text",
        "value": "{{AppKey}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n    \"ratePlan\": {\r\n        \"primaryDetails\": {\r\n            \"description\": {\r\n                \"defaultText\": \"Rate Code Description Goes Here\"\r\n            },\r\n            \"startSellDate\": \"2021-01-03\",\r\n            \"endSellDate\": \"2021-12-31\",\r\n            \"privilegedRate\": false,\r\n            \"privilegedRateRestriction\": false,\r\n            \"lockStatus\": \"Unlocked\"\r\n        },\r\n        \"classifications\": {\r\n            \"rateCategory\": \"HOTEL\",\r\n            \"marketCode\": \"LEISURE\"\r\n        },\r\n        \"transactionDetails\": {\r\n            \"folioText\": {\r\n                \"defaultText\": \"Accommodation\"\r\n            },\r\n            \"transactionCode\": \"1000\",\r\n            \"currencyCode\": \"USD\",\r\n            \"rateIncludesTax\": true\r\n        },\r\n        \"rateCommission\": {},\r\n        \"roomTypeList\": [\r\n            {\r\n                \"code\": \"ECO\"\r\n            },\r\n            {\r\n                \"code\": \"SGL\"\r\n            },\r\n            {\r\n                \"code\": \"DBL\"\r\n            },\r\n            {\r\n                \"code\": \"SUP\"\r\n            },\r\n            {\r\n                \"code\": \"JSUI\"\r\n            },\r\n            {\r\n                \"code\": \"SUI\"\r\n            }\r\n        ],\r\n        \"ratePackages\": {\r\n            \"packages\": [],\r\n            \"packageGroups\": []\r\n        },\r\n        \"controls\": {\r\n            \"sell\": {\r\n                \"minimumStayThrough\": \"1\",\r\n                \"minimumLengthOfStay\": \"1\"\r\n            },\r\n            \"yield\": {\r\n                \"yieldable\": \"NonYieldable\"\r\n            }\r\n        },\r\n        \"distribution\": {\r\n            \"restrictionUpdate\": false,\r\n            \"rateUpdate\": false,\r\n            \"myFidelioUploadAllowed\": false,\r\n            \"channelRateMappingExists\": false,\r\n            \"channelAllowed\": false\r\n        },\r\n        \"ratePlanBasedOnRates\": [\r\n            {\r\n                \"basedOnRatePlanType\": \"None\"\r\n            }\r\n        ],\r\n        \"approvalNotes\": [\r\n            {}\r\n        ],\r\n        \"mobileCheckinAllowed\": false,\r\n        \"mobileCheckoutAllowed\": false,\r\n        \"hotelId\": \"{{HotelId}}\",\r\n        \"ratePlanCode\": \"RACK123\",\r\n        \"supressRate\": false,\r\n        \"printRate\": true,\r\n        \"discountAllowed\": false,\r\n        \"redemption\": false,\r\n        \"bARRate\": false,\r\n        \"daily\": false,\r\n        \"tiered\": false,\r\n        \"dayUse\": false,\r\n        \"dayType\": false,\r\n        \"complimentary\": false,\r\n        \"houseUse\": false,\r\n        \"negotiated\": false,\r\n        \"ownerRate\": false,\r\n        \"membershipEligible\": true,\r\n        \"advancedDailyBase\": false,\r\n        \"advancedDailyRate\": false\r\n    }\r\n}"
    },
    "url": {
      "raw": "{{HostName}}/rtp/v0/hotels/{{HotelId}}/ratePlans",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "rtp",
        "v0",
        "hotels",
        "{{HotelId}}",
        "ratePlans"
      ]
    }
  },
  "response": [
  ]
}