Retrieve Rooms
The endpoint allows users to retrieve room details from Agoda using the hotel ID and channel hotel ID.
Endpoint
POST
https://connect-sandbox.su-api.com/SUAPI/jservice/agoda/room/retrieveHeader
app-id: c2l0****20=
Authorization: Basic M0****W0app-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 alphanumeric (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": "77048595"
}Response
{
"Status": "Success",
"Data": [
{
"channel_room_id": 1194119701,
"unit_name": "Su Super Room",
"description": "Description Of Su Super Room",
"room_view_type": "1",
"number_of_units": 1,
"number_of_bathrooms": 5,
"size": {
"value": 100
},
"occupancy": {
"max_guests": 10,
"max_adults": 5,
"max_children": 5,
"max_infants": 5,
"is_children_allowed": true,
"free_children_count": 1
},
"extra_beds_configuration": {
"max_extra_beds": 1,
"is_crib_allowed": true
},
"rates": {
"maximum_rate": 200,
"minimum_rate": 100,
"rack_rate": 122,
"standard_rate": 122
},
"configuration": {
"rooms": [
{
"type": "BEDROOM_SUBROOM",
"bed_configurations": {
"beds": [
{
"bed_type_id": 1,
"bed_count": 1
}
]
}
},
{
"type": "LIVING_ROOM_SUBROOM",
"bed_configurations": {
"beds": [
{
"bed_type_id": 1,
"bed_count": 1
},
{
"bed_type_id": 2,
"bed_count": 2
}
]
}
}
]
},
"facilities": [
{
"facility_id": "96",
"is_available": true
},
{
"facility_id": "97",
"is_available": true
},
{
"facility_id": "36",
"is_available": true
}
],
"images": [
{
"url": "https://d1wa2adzf09zfu.cloudfront.net/imagelibrary/17524748695021.jpg",
"imageid": "11909",
"tags": [
2
]
},
{
"url": "https://d1wa2adzf09zfu.cloudfront.net/imagelibrary/21257924603149.jpeg",
"imageid": "11910",
"tags": [
4
]
},
{
"url": "https://d1wa2adzf09zfu.cloudfront.net/imagelibrary/20456324283155.jpg",
"imageid": "11911",
"tags": [
4
]
}
],
"status": "Active"
},
{
"channel_room_id": 1194166472,
"unit_name": "Su Super Delux Room",
"description": "Su Super Delux Room Description",
"room_view_type": "1",
"number_of_units": 1,
"number_of_bathrooms": 1,
"size": {
"value": 1
},
"occupancy": {
"max_guests": 10,
"max_adults": 5,
"max_children": 5,
"max_infants": 5,
"is_children_allowed": true,
"free_children_count": 1
},
"extra_beds_configuration": {
"max_extra_beds": 1,
"is_crib_allowed": true
},
"rates": {
"maximum_rate": 200,
"minimum_rate": 100,
"rack_rate": 122,
"standard_rate": 122
},
"configuration": {
"rooms": [
{
"type": "BEDROOM_SUBROOM",
"bed_configurations": {
"beds": [
{
"bed_type_id": 1,
"bed_count": 1
}
]
}
}
]
},
"images": [
{
"url": "https://d1wa2adzf09zfu.cloudfront.net/imagelibrary/23270767228018.jpg",
"imageid": "11912",
"tags": [
2
]
},
{
"url": "https://d1wa2adzf09zfu.cloudfront.net/imagelibrary/22724412166036.png",
"imageid": "11913",
"tags": [
4
]
},
{
"url": "https://d1wa2adzf09zfu.cloudfront.net/imagelibrary/36431389315594.jpg",
"imageid": "11914",
"tags": [
4
]
}
],
"facilities": [
{
"facility_id": "96",
"is_available": true
},
{
"facility_id": "97",
"is_available": true
},
{
"facility_id": "36",
"is_available": true
}
],
"status": "Inactive"
}
],
"Message": "Room records retrieved Successfully"
}Response Body Elements
Status string
Indicates the result of the API call.
Data object
The response data, the root element.
channel_room_id string
Specifies the channel-specific room ID for the room.
unit_name string
Specifies the unit name ID that is part of the unit type.
description string
Detailed description of the room.
room_view_type enumerated integer
Identifier for the room view type. List : https://connect-sandbox.su-api.com/SUAPI/jservice/agoda/masterData
number_of_units integer
Specifies the total number of units available at the property.
number_of_bathrooms integer
Specifies the total number of bathrooms available in the room.
size object
Contains the unit size details.
value integer
Specifies the unit size in the unit: square meters (m2).
occupancy object
Contains the occupancy details for 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.
is_children_allowed boolean
Specifies whether children can stay in this room or not.
max_infants integer
Specifies the maximum infants occupancy for the unit.
free_children_count integer
Number of children allowed to stay in this room for free. Allow value from 0 to 9.
extra_beds_configuration object
Contains details for extra bed configuration in the unit.
extra_beds integer
Specifies the number of extra beds available on request per unit.
is_crib_allowed boolean
Specifies whether baby cots/cribs can be accommodated in this room or not.
rates object
Contains details for rates configuration for the unit.
maximum_rate integer
Maximum rate at which the room can be sold at. Same currency as property needs to be used. This does not restrict updates via ARI API’s. Setting this value will restrict users from manually updating rates via YCS. Value should be > MinimumRate and must be between 0 and 999999999.
minimum_rate integer
Minimum rate at which the room can be sold at. Same currency as property needs to be used. This does not restrict updates via our ARI API’s. Setting this value will restrict users from manually updating rates via YCS. Value should be < MaximumRateValue and must be between 0 and 999999999.
rack_rate integer
This is the full price rate for the room type. Same currency as Property needs to be used. Value must be between 0 and 999999999.
standard_rate integer
This is used as a default rate when updating rates in the extranet manually. Value must be between 0 and 999999999.
bed_configurations object
Contains details of the bed configuration for the room.
beds array
Contains the bed type and total number of beds available in the room.
bed_type_id enumerated integer
Specifies the bed type ID
List : https://connect-sandbox.su-api.com/SUAPI/jservice/agoda/masterData
bed_count integer
Specifies the total number of beds of the specified type in the room.
facilities object
Object containing available facilities at the room. https://connect-sandbox.su-api.com/SUAPI/jservice/agoda/masterData
facility_id integer
Unique identifier for the facility.
is_available boolean
Indicates if the facility is available at the room.
images object
Object containing room images.
url string
URL of the image.
imageid string
Unique identifier of an existing image. Basically a su_imageid you can retrieve from image api.
pms_imageid string
Id assigned to a specific image within the PMS. Please note the image with this pms_imageid should exist in the su system.
Note : one of 3 (url, imageid, pms_imageid) parameter should be there in request
tags array
An image caption code in Agoda. Maximum 1 tag per image allowed. https://connect-sandbox.su-api.com/SUAPI/jservice/agoda/masterData
status string
Specifies the status value that you want to set for the room. Should be one of these: “Active” , “Inactive” , “Deleted”
Message string
The message in the response.
Code string
Specific error code that helps identify the type of error.
ShortText string
A short description of the error.
Indicates channel room id and rate id.
Status string
Indicates the result of the API call.
Last updated
Was this helpful?