Chilkat Online Tools

TCL / ORACLE Hospitality OPERA Cloud REST API Workflows / Create a new upsell rule

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.

# {
#   "upsellRules": [
#     {
#       "description": "New Rule Description",
#       "upsellByRoomType": true,
#       "fromRoomTypeOrFromRoomClass": "STDK",
#       "toRoomTypeOrToRoomClass": "SUPK",
#       "startDate": "2022-03-03",
#       "endDate": "2023-12-31",
#       "rateCodes": [
#         "BARBB",
#         "BAR"
#       ],
#       "marketCodes": [
#       ],
#       "upsellByOccupancyLevels": false,
#       "formula": "FlatAmountAddedToOriginalRate",
#       "upsellAmount": "5",
#       "currencyCode": "USD",
#       "roundingRule": "Down",
#       "occupancyLevelsType": [
#       ],
#       "useDefaultTrxCode": true,
#       "transactionCode": {
#         "description": "Room Upsell",
#         "transactionCode": "1500",
#         "hotelId": "{{HotelId}}"
#       },
#       "hotelId": "{{HotelId}}",
#       "upsellRuleCode": "UPSELLRULECODE1"
#     }
#   ]
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "upsellRules[0].description" "New Rule Description"
CkJsonObject_UpdateBool $json "upsellRules[0].upsellByRoomType" 1
CkJsonObject_UpdateString $json "upsellRules[0].fromRoomTypeOrFromRoomClass" "STDK"
CkJsonObject_UpdateString $json "upsellRules[0].toRoomTypeOrToRoomClass" "SUPK"
CkJsonObject_UpdateString $json "upsellRules[0].startDate" "2022-03-03"
CkJsonObject_UpdateString $json "upsellRules[0].endDate" "2023-12-31"
CkJsonObject_UpdateString $json "upsellRules[0].rateCodes[0]" "BARBB"
CkJsonObject_UpdateString $json "upsellRules[0].rateCodes[1]" "BAR"
CkJsonObject_UpdateNewArray $json "upsellRules[0].marketCodes"
CkJsonObject_UpdateBool $json "upsellRules[0].upsellByOccupancyLevels" 0
CkJsonObject_UpdateString $json "upsellRules[0].formula" "FlatAmountAddedToOriginalRate"
CkJsonObject_UpdateString $json "upsellRules[0].upsellAmount" "5"
CkJsonObject_UpdateString $json "upsellRules[0].currencyCode" "USD"
CkJsonObject_UpdateString $json "upsellRules[0].roundingRule" "Down"
CkJsonObject_UpdateNewArray $json "upsellRules[0].occupancyLevelsType"
CkJsonObject_UpdateBool $json "upsellRules[0].useDefaultTrxCode" 1
CkJsonObject_UpdateString $json "upsellRules[0].transactionCode.description" "Room Upsell"
CkJsonObject_UpdateString $json "upsellRules[0].transactionCode.transactionCode" "1500"
CkJsonObject_UpdateString $json "upsellRules[0].transactionCode.hotelId" "{{HotelId}}"
CkJsonObject_UpdateString $json "upsellRules[0].hotelId" "{{HotelId}}"
CkJsonObject_UpdateString $json "upsellRules[0].upsellRuleCode" "UPSELLRULECODE1"

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

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/rsv/config/v0/hotels/{{HotelId}}/upsellRules" "application/json" $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"
	-H "x-hotelid: {{HotelId}}"
	-H "x-app-key: {{AppKey}}"
	-d '{
    "upsellRules": [
        {
            "description": "New Rule Description",
            "upsellByRoomType": true,
            "fromRoomTypeOrFromRoomClass": "STDK",
            "toRoomTypeOrToRoomClass": "SUPK",
            "startDate": "2022-03-03",
            "endDate": "2023-12-31",
            "rateCodes": [
                "BARBB",
                "BAR"
            ],
            "marketCodes": [],
            "upsellByOccupancyLevels": false,
            "formula": "FlatAmountAddedToOriginalRate",
            "upsellAmount": "5",
            "currencyCode": "USD",
            "roundingRule": "Down",
            "occupancyLevelsType": [],
            "useDefaultTrxCode": true,
            "transactionCode": {
                "description": "Room Upsell",
                "transactionCode": "1500",
                "hotelId": "{{HotelId}}"
            },
            "hotelId": "{{HotelId}}",
            "upsellRuleCode": "UPSELLRULECODE1"
        }
    ]
}'
https://domain.com/rsv/config/v0/hotels/{{HotelId}}/upsellRules

Postman Collection Item JSON

{
  "name": "Create a new upsell rule",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{Token}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      },
      {
        "key": "x-hotelid",
        "type": "text",
        "value": "{{HotelId}}"
      },
      {
        "key": "x-app-key",
        "type": "text",
        "value": "{{AppKey}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n    \"upsellRules\": [\r\n        {\r\n            \"description\": \"New Rule Description\",\r\n            \"upsellByRoomType\": true,\r\n            \"fromRoomTypeOrFromRoomClass\": \"STDK\",\r\n            \"toRoomTypeOrToRoomClass\": \"SUPK\",\r\n            \"startDate\": \"2022-03-03\",\r\n            \"endDate\": \"2023-12-31\",\r\n            \"rateCodes\": [\r\n                \"BARBB\",\r\n                \"BAR\"\r\n            ],\r\n            \"marketCodes\": [],\r\n            \"upsellByOccupancyLevels\": false,\r\n            \"formula\": \"FlatAmountAddedToOriginalRate\",\r\n            \"upsellAmount\": \"5\",\r\n            \"currencyCode\": \"USD\",\r\n            \"roundingRule\": \"Down\",\r\n            \"occupancyLevelsType\": [],\r\n            \"useDefaultTrxCode\": true,\r\n            \"transactionCode\": {\r\n                \"description\": \"Room Upsell\",\r\n                \"transactionCode\": \"1500\",\r\n                \"hotelId\": \"{{HotelId}}\"\r\n            },\r\n            \"hotelId\": \"{{HotelId}}\",\r\n            \"upsellRuleCode\": \"UPSELLRULECODE1\"\r\n        }\r\n    ]\r\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HostName}}/rsv/config/v0/hotels/{{HotelId}}/upsellRules",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "rsv",
        "config",
        "v0",
        "hotels",
        "{{HotelId}}",
        "upsellRules"
      ]
    }
  },
  "response": [
  ]
}