Room Retrieve API
This endpoint is used to retrieve details about rooms associated with a specific hotel and channel.
This endpoint allows you to fetch the room configuration, including details about the room type, occupancy, and extra beds for a given hotel and its associated channel.
Endpoint
POST
https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/room/retrieveHeader
-app-id: YOUR_APP_ID
Authorization: YOUR_API_KEY
Content-Type:application/jsonapp-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
hotel_id string (Required)
Specifies the hotel ID for the property.
channel_hotel_id string (Required)
Specifies the channel-specific hotel ID for the property.
Sample Request
{
"hotel_id": "AWSTEST",
"channel_hotel_id": "12962495"
}Response
Sample Success Response
{
"Status": "Success",
"Data": [
{
"channel_room_id": 1291567403,
"configuration": {
"unit_type_id": 1,
"rooms": [
{
"type": "BEDROOM_SUBROOM",
"bed_configurations": [
{
"beds": [
{
"bed_type_id": 1,
"bed_count": 1
}
],
"is_default_configuration": true
}
]
}
]
},
"unit_name_id": 565,
"number_of_units": 1,
"smoking_policy": "SMOKING_AND_NONSMOKING",
"size": {
"value": 1,
"unit": "SQM"
},
"partner_reference_name": "string",
"floor_numbers_located_on": [
0
],
"occupancy": {
"max_guests": 1,
"max_adults": 1,
"max_children": 0,
"max_children_that_pay_children_rate": 0
},
"extra_beds_configuration": {
"extra_beds": 0,
"cribs": 0,
"is_crib_and_extra_bed_allowed": false
}
},
{
"channel_room_id": 1291567404,
"configuration": {
"unit_type_id": 1,
"rooms": [
{
"type": "BEDROOM_SUBROOM",
"bed_configurations": [
{
"beds": [
{
"bed_type_id": 1,
"bed_count": 1
}
],
"is_default_configuration": true
}
]
}
]
},
"unit_name_id": 9,
"number_of_units": 1,
"smoking_policy": "SMOKING_AND_NONSMOKING",
"size": {
"value": 1,
"unit": "SQM"
},
"partner_reference_name": "string",
"floor_numbers_located_on": [
0
],
"occupancy": {
"max_guests": 1,
"max_adults": 1,
"max_children": 0,
"max_children_that_pay_children_rate": 0
},
"extra_beds_configuration": {
"extra_beds": 0,
"cribs": 0,
"is_crib_and_extra_bed_allowed": false
}
}
],
"Message": "Room Details Fetch Successfully",
"Ruid": "ae430cdd-777f-41d1-a6c1-1a38ed33325d"
}Success Response Body Elements
data object
Contains details of the unit created.
channel_room_id integer
Specifies the channel-specific room ID for the unit.
unit_id string
Specifies the unit ID.
configuration object
Contains the unit configuration.
unit_type_id enumerated string
Specifies the unit type ID.
rooms array of objects
Contains the room details provided the unit type supports rooms (also known as subrooms).
type enumerated string
Specifies the room type supported by the unit type.
bed_configurations object
Contains the details of the bed available in the room.
beds array of objects
Contains the bed type and the total number of beds.
bed_type_id enumerated integer
Specifies the bed type ID that is supported by the unit type.
bed_count integer
Specifies the total number of beds available in the unit/room.
is_default_configuration boolean
Specifies whether the specified bed configuration is default for the unit/room.
unit_name_id string
Specifies the unit name ID that is part of the unit type.
number_of_units integer
Specifies the total number of rooms available at the property for the specified room type.
smoking_policy enumerated string
Specifies the smoking policy in the room.
size object
Contains the unit size details.
value integer
Specifies the unit size in the chosen unit.
unit enumerated string
Specifies the unit of measurement to represent the unit size.
partner_reference_name string
Specifies a custom unit name that is visible in the extranet and in the API response.
floor_numbers_located_on array of integers
Specifies the floor where the unit is located.
occupancy object
Contains the occupancy details of the unit.
max_guests integer
Specifies the maximum guest occupancy for the unit.
max_adults integer
Specifies the maximum adult occupancy for the unit.
max_children integer
Specifies the maximum child occupancy for the unit.
max_children_that_pay_children_rate integer
Specifies the maximum number of children eligible for the child rate.
extra_beds_configuration object
Contains the extra beds details for the unit.
extra_beds integer
Specifies the total number of extra beds available on request per room/unit.
cribs integer
Specifies the total number of extra cribs available on request per room/unit.
is_crib_and_extra_bed_allowed integer
Specifies whether guests have the option of requesting both the extra bed and crib in the room/unit.
Message string
A message receives within the response body. This will generally be an empty string if no additional information is needed.
Ruid string
Specifies the unique request ID.
Errors
Sample Error Response 1
{
"Errors": [
{
"Code": "400",
"ShortText": "HotelCode: Invalid HotelCode ('NT711')"
}
],
"Status": "Fail"
}Sample Error Response 2
{
"Errors": [
{
"Code": "573",
"ShortText": "channel-mapping not found for this property!"
}
],
"Status": "Fail"
}Sample Error Response 3
{
"Status": "Fail",
"Errors": [],
"Message": "This account doesn't have access to this property.",
"Ruid": "87f3ee0d-5033-4063-ae5b-77f23d379ce5"
}Error Response Body Elements
Status string
Indicates the result of the API call, which will be always "Fail" in case of an error response.
Error array
Array that contains details about any errors that occurred during the API call. Each object in the Errors array contains the following properties:
Code string
Specific error code that helps identify the type of error.
ShortText string
A short description of the error.
Message string
A message providing more information about the error.
Ruid string
A unique identifier for tracking the request.
Last updated
Was this helpful?