Chilkat Online Tools

Python / ORACLE Hospitality OPERA Cloud REST API Workflows / Add packages to a Rate Plan

Back to Collection Items

import sys
import chilkat2

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

http = chilkat2.Http()

# 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": {
#     "hotelId": "{{HotelId}}",
#     "code": "PACKADD"
#   },
#   "packages": {
#     "packages": [
#       {
#         "scheduleExceptions": [
#         ],
#         "quantity": "1",
#         "header": {
#           "primaryDetails": {
#             "beginSellDate": "2020-01-01",
#             "endSellDate": "2031-01-31"
#           },
#           "postingAttributes": {
#             "addToRate": false,
#             "printSeparateLine": false,
#             "sellSeparate": false,
#             "postNextDay": false,
#             "forecastNextDay": true,
#             "deliveryTimeRequired": false,
#             "formula": "",
#             "startTime": "2021-03-12",
#             "endTime": "2031-03-12",
#             "postingRhythm": {
#               "type": "EveryNight"
#             },
#             "priceCalculationRule": "PerPerson"
#           }
#         },
#         "schedules": [
#           {
#             "schedulePrices": [
#               {
#                 "unitPrice": "25",
#                 "bucket": "Bucket1"
#               }
#             ],
#             "start": "2020-01-01",
#             "end": "2031-01-31"
#           }
#         ],
#         "hotelId": "{{HotelId}}",
#         "code": "BKFSTINC",
#         "description": "Breakfast"
#       }
#     ]
#   }
# }

json = chilkat2.JsonObject()
json.UpdateString("ratePlan.hotelId","{{HotelId}}")
json.UpdateString("ratePlan.code","PACKADD")
json.UpdateNewArray("packages.packages[0].scheduleExceptions")
json.UpdateString("packages.packages[0].quantity","1")
json.UpdateString("packages.packages[0].header.primaryDetails.beginSellDate","2020-01-01")
json.UpdateString("packages.packages[0].header.primaryDetails.endSellDate","2031-01-31")
json.UpdateBool("packages.packages[0].header.postingAttributes.addToRate",False)
json.UpdateBool("packages.packages[0].header.postingAttributes.printSeparateLine",False)
json.UpdateBool("packages.packages[0].header.postingAttributes.sellSeparate",False)
json.UpdateBool("packages.packages[0].header.postingAttributes.postNextDay",False)
json.UpdateBool("packages.packages[0].header.postingAttributes.forecastNextDay",True)
json.UpdateBool("packages.packages[0].header.postingAttributes.deliveryTimeRequired",False)
json.UpdateString("packages.packages[0].header.postingAttributes.formula","")
json.UpdateString("packages.packages[0].header.postingAttributes.startTime","2021-03-12")
json.UpdateString("packages.packages[0].header.postingAttributes.endTime","2031-03-12")
json.UpdateString("packages.packages[0].header.postingAttributes.postingRhythm.type","EveryNight")
json.UpdateString("packages.packages[0].header.postingAttributes.priceCalculationRule","PerPerson")
json.UpdateString("packages.packages[0].schedules[0].schedulePrices[0].unitPrice","25")
json.UpdateString("packages.packages[0].schedules[0].schedulePrices[0].bucket","Bucket1")
json.UpdateString("packages.packages[0].schedules[0].start","2020-01-01")
json.UpdateString("packages.packages[0].schedules[0].end","2031-01-31")
json.UpdateString("packages.packages[0].hotelId","{{HotelId}}")
json.UpdateString("packages.packages[0].code","BKFSTINC")
json.UpdateString("packages.packages[0].description","Breakfast")

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 is a CkHttpResponse
resp = http.PostJson3("https://domain.com/rtp/v0/hotels/{{HotelId}}/ratePlans/{{RatePlanCode}}/packages","application/json;charset=UTF-8",json)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

print(str(resp.StatusCode))
print(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": {
        "hotelId": "{{HotelId}}",
        "code": "PACKADD"
    },
    "packages": {
        "packages": [
            {
                "scheduleExceptions": [],
                "quantity": "1",
                "header": {
                    "primaryDetails": {
                        "beginSellDate": "2020-01-01",
                        "endSellDate": "2031-01-31"
                    },
                    "postingAttributes": {
                        "addToRate": false,
                        "printSeparateLine": false,
                        "sellSeparate": false,
                        "postNextDay": false,
                        "forecastNextDay": true,
                        "deliveryTimeRequired": false,
                        "formula": "",
                        "startTime": "2021-03-12",
                        "endTime": "2031-03-12",
                        "postingRhythm": {
                            "type": "EveryNight"
                        },
                        "priceCalculationRule": "PerPerson"
                    }
                },
                "schedules": [
                    {
                        "schedulePrices": [
                            {
                                "unitPrice": "25",
                                "bucket": "Bucket1"
                            }
                        ],
                        "start": "2020-01-01",
                        "end": "2031-01-31"
                    }
                ],
                "hotelId": "{{HotelId}}",
                "code": "BKFSTINC",
                "description": "Breakfast"
            }
        ]
    }
}\''
https://domain.com/rtp/v0/hotels/{{HotelId}}/ratePlans/{{RatePlanCode}}/packages

Postman Collection Item JSON

{
  "name": "Add packages to a Rate Plan",
  "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        \"hotelId\": \"{{HotelId}}\",\r\n        \"code\": \"PACKADD\"\r\n    },\r\n    \"packages\": {\r\n        \"packages\": [\r\n            {\r\n                \"scheduleExceptions\": [],\r\n                \"quantity\": \"1\",\r\n                \"header\": {\r\n                    \"primaryDetails\": {\r\n                        \"beginSellDate\": \"2020-01-01\",\r\n                        \"endSellDate\": \"2031-01-31\"\r\n                    },\r\n                    \"postingAttributes\": {\r\n                        \"addToRate\": false,\r\n                        \"printSeparateLine\": false,\r\n                        \"sellSeparate\": false,\r\n                        \"postNextDay\": false,\r\n                        \"forecastNextDay\": true,\r\n                        \"deliveryTimeRequired\": false,\r\n                        \"formula\": \"\",\r\n                        \"startTime\": \"2021-03-12\",\r\n                        \"endTime\": \"2031-03-12\",\r\n                        \"postingRhythm\": {\r\n                            \"type\": \"EveryNight\"\r\n                        },\r\n                        \"priceCalculationRule\": \"PerPerson\"\r\n                    }\r\n                },\r\n                \"schedules\": [\r\n                    {\r\n                        \"schedulePrices\": [\r\n                            {\r\n                                \"unitPrice\": \"25\",\r\n                                \"bucket\": \"Bucket1\"\r\n                            }\r\n                        ],\r\n                        \"start\": \"2020-01-01\",\r\n                        \"end\": \"2031-01-31\"\r\n                    }\r\n                ],\r\n                \"hotelId\": \"{{HotelId}}\",\r\n                \"code\": \"BKFSTINC\",\r\n                \"description\": \"Breakfast\"\r\n            }\r\n        ]\r\n    }\r\n}'"
    },
    "url": {
      "raw": "{{HostName}}/rtp/v0/hotels/{{HotelId}}/ratePlans/{{RatePlanCode}}/packages",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "rtp",
        "v0",
        "hotels",
        "{{HotelId}}",
        "ratePlans",
        "{{RatePlanCode}}",
        "packages"
      ]
    },
    "description": "Use this operation to add a package (such as Breakfast, or box of chocolated) to a rate plan."
  },
  "response": [
  ]
}