OTA Rateplan Pull API

This endpoint allows you to retrieve detailed information about the rate plans available for a specified hotel, including different room types, rate plans, and their associated details.

---

Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/OTARateplanPull

Header

-app-id: YOUR_APP_ID
Authorization: YOUR_API_KEY
Content-Type:application/json

Header	Type	Required	Description
app-id	string	Yes	Your application ID. Required for authentication.
Authorization	string	Yes	Your API key. for authorization. Required for authentication.
Content-Type	string	Yes	Must be set to application/json.

Attributes

hotelid alphanumeric (Required)

The unique property ID as assigned by the provider upon creation of the property.

---

channelid string (Required)

Generated while delivering reviews from OTA.

---

channelhotelid alphanumeric (Required)

The unique property ID as assigned by the channel.

---

Sample Request

Please find an example input message below.

{
   "hotelid": "TPBE",
   "channelid": "9",
   "channelhotelid": "123Test"
}

---

Response

Success Response

{
   "status": "Success",
   "data": [
       {
           "type": "manageable",
           "mappedname": "Basic Room-Breakfast Included(manageable)",
           "roomtypename": "Basic Room",
           "roomtype_id": "210023573",
           "rateplanname": "Breakfast Included",
           "rateplan_id": "220141455A",
           "rateplan_code": "",
           "mappingformula": "210023573####220141455A",
           "mapping_rateplan": "220141455A",
           "fixed_occupany": "",
           "is_child": ""
       },
       {
           "type": "nonmanageable",
           "mappedname": "Basic Room-Breakfast Included(nonmanageable)",
           "roomtypename": "Basic Room",
           "roomtype_id": "210023573",
           "rateplanname": "Breakfast Included",
           "rateplan_id": "220141455",
           "rateplan_code": "",
           "mappingformula": "210023573####220141455",
           "mapping_rateplan": "220141455",
           "fixed_occupany": "",
           "is_child": ""
       },
       {
           "type": "nonmanageable",
           "mappedname": "Basic Room-Breakfast Included(nonmanageable)",
           "roomtypename": "Basic Room",
           "roomtype_id": "210023573",
           "rateplanname": "Breakfast Included",
           "rateplan_id": "220141456",
           "rateplan_code": "",
           "mappingformula": "210023573####220141456",
           "mapping_rateplan": "220141456",
           "fixed_occupany": "",
           "is_child": ""
       },
       {
           "type": "nonmanageable",
           "mappedname": "Basic Room-Egencia(nonmanageable)",
           "roomtypename": "Basic Room",
           "roomtype_id": "210023573",
           "rateplanname": "Egencia",
           "rateplan_id": "220142597A",
           "rateplan_code": "",
           "mappingformula": "210023573####220142597A",
           "mapping_rateplan": "220142597A",
           "fixed_occupany": "",
           "is_child": ""
       },
       {
           "type": "nonmanageable",
           "mappedname": "Basic Room-Egencia(nonmanageable)",
           "roomtypename": "Basic Room",
           "roomtype_id": "210023573",
           "rateplanname": "Egencia",
           "rateplan_id": "220142597",
           "rateplan_code": "",
           "mappingformula": "210023573####220142597",
           "mapping_rateplan": "220142597",
           "fixed_occupany": "",
           "is_child": ""
       },
       {
           "type": "nonmanageable",
           "mappedname": "Basic Room-Breakfast IncludedMOD(nonmanageable)",
           "roomtypename": "Basic Room",
           "roomtype_id": "210023573",
           "rateplanname": "Breakfast IncludedMOD",
           "rateplan_id": "386139529A",
           "rateplan_code": "",
           "mappingformula": "210023573####386139529A",
           "mapping_rateplan": "386139529A",
           "fixed_occupany": "",
           "is_child": ""
       },
       {
           "type": "nonmanageable",
           "mappedname": "Basic Room-Breakfast IncludedMOD(nonmanageable)",
           "roomtypename": "Basic Room",
           "roomtype_id": "210023573",
           "rateplanname": "Breakfast IncludedMOD",
           "rateplan_id": "386139529",
           "rateplan_code": "",
           "mappingformula": "210023573####386139529",
           "mapping_rateplan": "386139529",
           "fixed_occupany": "",
           "is_child": ""
       },
       {
           "type": "manageable",
           "mappedname": "Standard Room-Breakfast Included(manageable)",
           "roomtypename": "Standard Room",
           "roomtype_id": "210023575",
           "rateplanname": "Breakfast Included",
           "rateplan_id": "220141458A",
           "rateplan_code": "",
           "mappingformula": "210023575####220141458A",
           "mapping_rateplan": "220141458A",
           "fixed_occupany": "",
           "is_child": ""
       },
       {
           "type": "nonmanageable",
           "mappedname": "Standard Room-Breakfast Included(nonmanageable)",
           "roomtypename": "Standard Room",
           "roomtype_id": "210023575",
           "rateplanname": "Breakfast Included",
           "rateplan_id": "220141458",
           "rateplan_code": "",
           "mappingformula": "210023575####220141458",
           "mapping_rateplan": "220141458",
           "fixed_occupany": "",
           "is_child": ""
       },
       {
           "type": "nonmanageable",
           "mappedname": "Standard Room-Breakfast Included(nonmanageable)",
           "roomtypename": "Standard Room",
           "roomtype_id": "210023575",
           "rateplanname": "Breakfast Included",
           "rateplan_id": "220141460",
           "rateplan_code": "",
           "mappingformula": "210023575####220141460",
           "mapping_rateplan": "220141460",
           "fixed_occupany": "",
           "is_child": ""
       },
       {
           "type": "nonmanageable",
           "mappedname": "Standard Room-Egencia(nonmanageable)",
           "roomtypename": "Standard Room",
           "roomtype_id": "210023575",
           "rateplanname": "Egencia",
           "rateplan_id": "220142598A",
           "rateplan_code": "",
           "mappingformula": "210023575####220142598A",
           "mapping_rateplan": "220142598A",
           "fixed_occupany": "",
           "is_child": ""
       },
       {
           "type": "nonmanageable",
           "mappedname": "Standard Room-Egencia(nonmanageable)",
           "roomtypename": "Standard Room",
           "roomtype_id": "210023575",
           "rateplanname": "Egencia",
           "rateplan_id": "220142598",
           "rateplan_code": "",
           "mappingformula": "210023575####220142598",
           "mapping_rateplan": "220142598",
           "fixed_occupany": "",
           "is_child": ""
       },
       {
           "type": "nonmanageable",
           "mappedname": "Standard Room-Breakfast IncludedMOD(nonmanageable)",
           "roomtypename": "Standard Room",
           "roomtype_id": "210023575",
           "rateplanname": "Breakfast IncludedMOD",
           "rateplan_id": "386139530A",
           "rateplan_code": "",
           "mappingformula": "210023575####386139530A",
           "mapping_rateplan": "386139530A",
           "fixed_occupany": "",
           "is_child": ""
       },
       {
           "type": "nonmanageable",
           "mappedname": "Standard Room-Breakfast IncludedMOD(nonmanageable)",
           "roomtypename": "Standard Room",
           "roomtype_id": "210023575",
           "rateplanname": "Breakfast IncludedMOD",
           "rateplan_id": "386139530",
           "rateplan_code": "",
           "mappingformula": "210023575####386139530",
           "mapping_rateplan": "386139530",
           "fixed_occupany": "",
           "is_child": ""
       }
   ]
}

Error Response

Errors Response 1

{
   "Errors": {
       "Code": "400",
       "ShortText": "hotelid: Invalid HotelCode ('TPBE')"
   },
   "Status": "Fail"
}

Errors Response 2

{
   "Errors": {
       "Code": "472",
       "ShortText": "channelid is not valid or not found!"
   },
   "Status": "Fail"
}

Errors Response 3

{
   "Errors": {
       "Code": "981",
       "ShortText": "channelhotelid is not defined or invalid value"
   },
   "Status": "Fail"
}

Errors Response 4

Authorization Required