Chilkat Online Tools

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

Back to Collection Items

load ./chilkat.dll

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

set 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.

# {
#   "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
#   }
# }

set json [new_CkJsonObject]

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

CkHttp_SetRequestHeader $http "Content-Type" "application/json;charset=UTF-8"
CkHttp_SetRequestHeader $http "x-hotelid" "{{HotelId}}"
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Accept" "application/json;charset=UTF-8"
CkHttp_SetRequestHeader $http "x-app-key" "{{AppKey}}"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/rtp/v0/hotels/{{HotelId}}/ratePlans" "application/json;charset=UTF-8" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json

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