Retrieve Property

This endpoint retrieves detailed information about a specific property using its hotel_id and channel_hotel_id.


Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/property/retrieve

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 unique id for the hotel on the specific channel.


Sample Request

{
    "hotel_id": "new1",
    "channel_hotel_id": "12905777"
}

Response

Sample Success Response

{
    "Status": "Success",
    "Ruid": "e527c45a-f23a-4ee4-beb2-7d21f7699b1b",
    "Data": {
        "translations": [],
        "position": {
            "latitude": -36.8485,
            "longitude": 174.76339
        },
        "check_in": {
            "from": "12:30"
        },
        "check_out": {
            "from": "10:00",
            "until": "10:30"
        },
        "property_name": "TP TEST hotel NZ",
        "property_category": 30,
        "primary_language": "en-nz",
        "languages_spoken": [
            "en-nz"
        ],
        "room_count": 8,
        "floor_count": 1,
        "currency_code": "NZD",
        "stars": "4",
        "target": "test",
        "property_id": 12905777,
        "status": "Test Hotel",
        "physical_address": {
            "city_name": "Auckland",
            "country_code": "NZ",
            "postal_code": "1010",
            "address_line": "123 Queen Street",
            "display_address": true
        },
        "legal_entity_id": 78775
    },
    "Message": "Property detail fetched successfully"
}

Success Response Body Elements

Status string

The success or failure of the operation.


Ruid string

Specifies the unique request ID.

You can share this ID with Booking.com customer support when you run into an issue. This can help in understanding what went wrong.


Data object

Contains detailed information about the property (the response data).


translations array (of objects)

List of translations for the property details..


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 times.

A value of 00:00 for both from and until means the property accepts 24-hour check in.

from enumerated string

Start time for check-in.

until enumerated string

End time for check-in.


check_out object

Object containing check-out times.

A value of 00:00 for both from and until means the property accepts 24-hour check in.

from enumerated string

Start time for check-out.

until enumerated string

End time for check-out (required if check_out > from is specified).


property_name string

Name of the hotel property on Booking.com.


property_category integer

Category identifier for the hotel.


primary_language string

Main preffered language spoken at the property.


languages_spoken array (of strings)

List of languages spoken at the property.


room_count integer

Number of sellable units/rooms available at the hotel.


floor_count integer

The total number of floors in the building/hotel, excluding the underground floors.


currency_code enumerated string

The Booking.com defined currency for the property.


stars string

The number of stars, rating of the hotel.


target enumerated string

Specifies whether it is a test or production-ready property.

Contains one of the following values:

  • test

  • production


property_id string

Identifier for the property provider.

Recommended for new properties. For example, the provider's internal ID. Can contain a maximum of 16 characters.


status string

Current status or condition of the property.

Indicates if the property is operational, under renovation, etc.

See allowable values of the statuses and their recommended actions, click Property Status Values and Recommended Actions.


physical_address object

Object containing address details.

city_name string

City where the hotel is located.

country_code enumerated string

ISO code for the country (IN for India).

postal_code string

Postal code of the hotel's location.

address_line string

Detailed address of the hotel.

display_address boolean

Boolean indicating if the address should be displayed.

- true : Shows the full address to the guest. - false : Hides the full address from the guest.


legal_entity_id string

The unique id for the legal entity associated with the hotel.


Message string

The message in the response.

Provides feedback to users or systems about the request.


Sample Error Response

{
    "Status": "Fail",
    "Errors": [
        {
            "Code": "400",
            "ShortText": "hotel_id: Invalid HotelCode ('')"
        },
        {
            "Code": "572",
            "ShortText": "channel_hotel_id - is invalid or not found!"
        }
    ],
    "Message": "",
    "Ruid": ""
}

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.

For example: "400" indicates a bad request.

ShortText string

A short description of the error.


Message string

A message providing more information about the error.

Last updated

Was this helpful?