Retrieve Property
The endpoint allows users to retrieve property details from Agoda using the hotel ID and channel hotel ID.
Endpoint
POST
https://connect-sandbox.su-api.com/SUAPI/jservice/agoda/property/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)
The unique property ID as assigned by the provider upon creation of the property.
channel_hotel_id string (Required)
The existing Agoda channel hotel ID for the property to be updated.
Sample Request
{
"hotel_id": "existing1",
"channel_hotel_id": "77048595"
}
Response
{
"Status": "Success",
"Data": {
"property_name": "MH Test Property1",
"currency_code": "NZD",
"property_category": "30",
"stars": "4",
"description": "property Description",
"contacts": {
"contact_person": {
"name": "Meet",
"last_name": "P"
},
"phones": {
"phone_number": "+31243611111"
},
"email": "tests@booking.com"
},
"physical_address": {
"address_line": "123 Queen Street",
"country_code": "KM",
"city_name": "Test City",
"postal_code": "0698"
},
"position": {
"latitude": -11.636096,
"longitude": 43.331237
},
"check_in": {
"from": "12:30"
},
"check_out": {
"from": "10:00"
},
"channel_hotel_id": 77048595,
"cancel_penalty": [
{
"policy_code": "4459",
"start_date": "2025-07-22",
"end_date": "2026-07-31"
},
{
"policy_code": "4459",
"start_date": "2026-07-23"
}
],
"property_settings": {
"age_restriction": {
"min_guest_age": 1,
"max_infant_age": 5
},
"children_policies": {
"child_stay_free": true,
"child_stay_free_typeid": 1,
"max_age": 19,
"extra_bed_required_from_age": 20,
"policy_rules": [
{
"from_age": 1,
"to_age": 3,
"rule_description": "Test Age Description"
},
{
"from_age": 4,
"to_age": 17,
"rule_description": "Test Age Description"
}
]
}
},
"facilities": [
{
"facility_id": "5",
"is_available": true
},
{
"facility_id": "7",
"is_available": true
},
{
"facility_id": "761",
"is_available": true
}
],
"images": [
{
"is_primary": "true",
"tags": "6",
"imageid": "11930",
"url": "https://suissusit.otaswitch.com/images/fc0fc5824e6b6b0f47824e4eb25b5455.jpg"
},
{
"imageid": "11910",
"tags": "4",
"url": "https://suissusit.otaswitch.com/images/2355686c019257d666febfec3e378e16.png"
},
{
"imageid": "11911",
"tags": "7",
"url": "https://suissusit.otaswitch.com/images/2db5592a0e2a42b58c85d5692d526d02.png"
}
],
"room_count": 5,
"rental_license": "12343",
"fee_policies": [
{
"policy_code": "76",
"amount": "1000",
"start_date": "2025-05-05",
"end_date": "2026-06-05"
},
{
"policy_code": "77",
"amount": "1000",
"start_date": "2025-05-05",
"end_date": "2026-06-05"
}
],
"local_recommendations": [
{
"description": "Recommendations 1"
},
{
"description": "Recommendations 1"
}
],
"house_rules": [
{
"description": "house_rules 1"
},
{
"description": "house_rules 1"
}
],
"directions": [
{
"description": "directions 1"
},
{
"description": "directions 1"
}
],
"tax_policies": [
{
"policy_code": "76",
"amount": "1000",
"start_date": "2025-05-05",
"end_date": "2026-06-05"
},
{
"policy_code": "77",
"amount": "1000",
"start_date": "2025-05-05",
"end_date": "2026-06-05"
}
],
"contract_signed": false
},
"Message": "Property details retrieved successfully"
}Response Body Element
Status string
The status of the response.
Data object
The response data, the root element.
property_name string
Name of the hotel property on Agoda.
currency_code enumerated string
The Agoda defined currency for the property (e.g., USD,NZD).
property_category integer
Category identifier for the hotel. Must be a valid Agoda hotel category code.
stars string
The number of stars, rating of the hotel. Accepts values: 0–5, with increments of 0.5.
contacts object
Object containing contact information.
contact_person object
Details of the contact person.
name string
Contact person's first name.
last_name string
Contact person's last name.
phones object
Details of the phone.
phone_number string
Contact phone number.
email string
Contact email address.
physical_address object
Object containing address details.
city_name string
City where the hotel is located.
country_codeenumerated string
ISO code for the country (e.g., NZ for New Zealand).
postal_code string
Postal code of the hotel's location.
address_line string
Detailed address of the hotel. Should not exceed 255 characters.
position object
Object containing geographical coordinates of the property.
latitude double
Latitude coordinates of the hotel location.
longitude double
Longitude coordinates of the hotel location.
check_in object
Object containing check-in time.
from enumerated string
Start time for check-in. Specify 24-hour check-in by using 00:00
check_out object
Object containing check-out time.
from enumerated string
Start time for check-out. Specify 24-hour check-in by using 00:00
channel_hotel_id string
Specifies the channel-specific hotel ID for the property.
cancel_penalty object
Object Containing cancellation policy details.
policy_code string
Cancellation policy code.
start_date string
Start date for the policy. Format: YYYY-MM-DD.
end_date string
End date for the policy. Format: YYYY-MM-DD.
property_settings object
Object containing property-specific settings.
age_restriction object
Deatils of the age restrictions.
min_guest_age integer
Minimum age required for guests.
max_infant_age integer
Maximum age for infants.
children_policies object
Children policy details such as maximum age, extra bed related.
max_age integer
Maximum age for children.
extra_bed_required_from_age integer
Age from which extra bed is required.
child_stay_free boolean
Indicates if children can stay for free.
child_stay_free_typeid integer
Type ID for child stay free policy. 1: All child stay free - Does not consider max occ no. in room level. 2: Limit no. of child stay free base on max occ, apart from that will be cost in the property.
policy_rules object
Object Containing child policy rules.
from_age integer
Starting age for the rule.
to_age integer
Ending age for the rule.
rule_description string
Description of the policy rule.
facilities object
Object containing available facilities at the property.
facility_id integer
Unique identifier for the facility.
is_available boolean
Indicates if the facility is available at the property.
images object
Object containing property images. Minimum 3 images required.
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) parameters should be there in request.
is_primary boolean
Indicates if this is the primary image. Exactly one image must be marked as primary.
tags string
An image caption code in Agoda.
room_count integer
Number of rooms/units available for rent.
rental_license string
Official rental license number.
fee_policies object
Object containing additional fee policies. Recommended for vacation rental.
policy_code string
Fee policy code.
amount string
Fee amount.
local_recommendations object
Object Containing local area recommendations. Recommended for vacation rental.
description string
Description of the recommendation.
house_rules object
Object Containing property house rules. Recommended for vacation rental.
description string
Description of the house rule.
directions object
Object Containing directions to the property. Recommended for vacation rental.
description string
Description of the direction.
tax_policies object
Object containing additional tax policies. Recommended for vacation rental.
policy_code string
Tax policy code.
amount string
Tax amount.
start_date string
Effective start date. Format: YYYY-MM-DD.
end_date string
Expiration date. Format: YYYY-MM-DD.
contract_signed
Indicates whether contract signed or not on Agoda for property.
Message string
The message in the response.
Last updated
Was this helpful?