Su API Documentation
  • Su Overview
    • Su API Introduction
  • Su Channel Manager
    • Getting Started
      • Certification
      • Authentication
    • Content
      • Property
      • Room Type
      • Rate Plan
      • Listing
        • Property Listing
        • Room Type Listing
        • Rate Plan Listing
        • Delete Property Listing
      • Image API
        • Create Images
        • Retrieve Images
        • Associate Images
    • Booking.com Content API
      • Booking.com
        • Contract - Introduction
          • Create Contract
          • Link/Retrieve Contract
          • Update Contract
          • Resend Contract
        • Property Management
          • Property Statuses
          • Property Detail
            • Create Property
            • Retrieve Property
            • Update Property
          • Contact Details
            • Set Contact
            • Retrieve Contact
            • Contact Profile Types
          • Property Settings
            • Retrieve Property Settings
            • Retrieve Property Settings Damage Programme
            • Retrieve City Tax Category For Property Settings
            • Create / Update Property Settings
            • Create / Update Property Settings - Specific Setting
          • Property Profile
            • Set Profile
            • Retrieve Property Profile
            • Set Hotelier Message
            • Retrieve Hotelier Message
            • Remove Hotelier-Message
          • Booking.com Property Status
            • Property Status Check
            • Property Status Open
            • Property Status Closed
          • Property Key Collection
            • Set CheckIn Methods
            • Retrieve CheckIn Method
            • Retrieve All Stream Variation
        • Images
          • Create Image
          • Retrieve All Images
          • Update Image Tags
          • Delete Image
          • Retrieve Associate Images
          • Associate Image
          • Unassociate Image
          • Ordering Image
          • Smart Ordering Image
          • Show Image
          • Retrieve Property Pending Photos based on photo-batch-id
          • Retrieve Image Tags
        • Facilities
          • Create/Update Facility
          • Retrieve Set Facility of Property and Room
          • Retrieve Supported Facilities
        • Property/Room Charges
          • Retrieve Property Charge Meta
          • Retrieve Property Charges
          • Retrieve Room Charges
          • Create Property Charges
        • Rate Plan
          • Set Rateplan
          • Retrieve Rateplan
      • Room API
        • Room Meta API
        • Room Set (Create/Update) API
        • Room Retrieve API
        • Room Deactivate API
      • Policies API
        • Create/Update Policies
        • Retrieve Policies
      • Bathroom API
        • Set Bathroom (Create and Update)
        • Remove/Disable Bathroom
        • Retrieve Bathroom
      • Product API
        • Product Meta
        • Product List
        • Product Create
        • Product Modify
        • Product Remove
        • Product Map Create (Room Based)
        • Product Map Modify (Room Based)
        • Product Map Create (Occupancy Based)
        • Product Map Modify (Occupancy Based)
        • Product Unmap
      • Property and Room License
        • Property License Retrieve All Rule (Without property id)
        • Property License Retrieve Rule (With property id)
        • Sending License Information of Property
        • Retrieve License Information of Property
        • Sending License Information of Room
        • Retrieve License Information of Room
      • BCIO (Booking.com Check-In / Check-Out Times)
      • PCT (Property Class Type Codes)
      • BCJT (Booking.com Job Titles)
      • PTT (Phone Technology Type Codes)
      • BCL (Booking.com Language Codes)
      • Currency Codes/Names
      • Country Codes/Names
      • BCPT (Booking.com Payment Type Codes)
    • Rates and Availability
    • Inventory Control
    • Reservations
      • New/Modified/Requested/Cancelled Retrievals
        • Request for Reservation Information
        • Response of Reservation Information
      • Reservation Using Push API
        • Reservations Notification Push
        • PUSH API Method
      • Reservation Notification
      • Request Booking
        • Accept/Confirm Request Booking
        • Deny/Cancel Request Booking
      • Booking Repull
        • List of Bookings
        • Refetch Booking
    • Logs
      • Update Logs
      • Failed Channel Logs
      • Rates & Inventory Logs (Future Date)
      • Bulk Rates & Inventory Logs (Future Date)
      • Resync OTA Updates (Failed)
      • OTA Rateplan Pull API
    • Users
      • Global Users
      • Chain Users
    • Channel Mapping Widget API
      • Generate a Token
      • Mapping Script
    • Reviews
    • Messaging
    • Reporting
      • Reporting - No Show (Booking.com & Goibibo)
      • Reporting - Invalid CC (Booking.com)
      • Reporting - Cancellation Due to Invalid CC (Booking.com)
      • Bulk ARI Update
      • Marketing Insight API - Booking.com
    • AirBnB
      • Cancel Reservation
        • Retrieve AirBnB Cancel Reservation Details API
        • Final AirBnB Cancel Reservation API
      • Notification
      • Trip Issue
    • My Booking Site
      • Confirm Reservation
      • Cancel Reservation
  • Su Token
    • Su Token - Introduction
    • Su Token - Authentication
    • Partner
    • Card
      • Card API
      • Card View API
      • Charge API
      • Card Collection
        • Get CC Collection (Generate Link)
        • Check Status of CC Collection
      • WIDGET
        • CC Collection Using Widget
  • Codes
    • Room Type Codes
    • Language Codes
    • Country Codes
    • Phone Technology Type Codes
    • Meal Plan Codes
    • Currency Codes
    • Channel or OTA Codes
    • Credit Card Type Codes
    • Time Zones
    • Error Codes
  • Versioning
  • Glossary of Terms
Powered by GitBook

STAAH Limited. 2024 © All Rights Reserved.

On this page
  • Endpoint
  • Sample Request
  • Response

Was this helpful?

Export as PDF
  1. Su Channel Manager
  2. Booking.com Content API
  3. Booking.com
  4. Property Management
  5. Property Detail

Retrieve Property

PreviousCreate PropertyNextUpdate Property

Last updated 20 days ago

Was this helpful?

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.