Hotel Details API Reference
|
Get |
search/propertiesdetail?chainCode={XY}&propertyCode={12345} Use this base path if you have not yet received or not migrated to the new credentials from Travelport:
Use this base path after you have migrated to the new credentials from Travelport (using .net instead of .com):
|
Related Content: JSON Hotel APIs Guide
The Hotel Details request retrieves for a specified property a detailed description and images provided by the supplier. It is an optional request and does not need to be preceded by a search request.
Request
Query Parameters
| Parameter | Description | Required/Optional |
|---|---|---|
|
chainCode |
String. The chain code of the requested property. |
Required |
|
propertyCode |
String. The 5-character alphanumeric property code of the requested property. |
Required |
|
ImageSize |
String. The size of the images to return. Supported values:
|
Optional |
Request Body
None.
Response
The example response below returns details for property id XV-89550.
PropertiesResponse
Top level object for response. Includes Properties object. Properties:
transactionId: System-generated unique ID for this response. Can be used for internal tracking and troubleshooting. Not returned in all Hotel API responses.
traceId: Returned if a custom trace ID was sent in the request header.
See Identifiers in the JSON APIs for more about identifiers across the JSON Hotel APIs.
Properties
Top level object for response.
Includes PropertyInfo object.
PropertyInfo
All information returned about the requested property.
Properties:
id: Property ID composed of the chain and property codes.
Includes Property and Distance objects.
Distance
Property
Property ID information. Properties:
name: Text string for the name of the property.
id: Property ID composed of the chain and property codes.
Depending on the information returned from the supplier, may includes Rating, GeoLocation, Image, Description, BusinessService, AccessibilityFeature, GuestRoomInfo, Address, Telephone, Email, PropertyAmenity, Attraction, and CheckInOutPolicy objects.
PropertyKey
The property chain code and property code. Properties:
chainCode: Two-character code for the hotel chain.
propertyCode: Code for the property within the hotel chain.
Image
Array. Each instance is one image for the property and accompanying details including a link to the image. Key value pairs; not all may be returned:
value: The URL for the image.
dimensionCategory:Image size category. Possible values and meanings are:
- S: Small
- M: Medium
- T: Thumbnail
- L: Large
width: Image width.
height: Image height.
caption: Image caption.
pictureCategory: The image category number. Possible values and meanings are:
- 1: exterior
- 2: lobby
- 3: pool
- 4: restaurant
- 5: health club
- 6: guestroom
- 7: suite
- 8: conference room
- 9: ballroom
- 10: golf
- 11: beach
- 12: spa
- 13: bar
- 14: recreational
- 21: room amenity
- 22: property amenity
- 23: business center
Description
A text description of the property.
AccessibilityFeature
Array. One instance for each accessibility option offered. Properties:
description: Free text description of feature.
value: OTA code for this feature.
GuestRoomInfo
Array. One instance for each type of information about the guest rooms, such as total number of rooms and number of floors. Properties:
code: OTA code for this description.
number: Number of rooms with this feature or type of information.
description: Text string for the guest room information.
Address
Property address. Properties:
City: Property city.
PostalCode: Property postal code.
Includes AddressLine, StateProv, Country, and PostalCode objects.
AddressLine
Text string for property street address.
StateProv
Property state or province. Properties:
value: The state or province code of the property address.
Country
Property country. Properties:
name: Country name.
value: Property country code.
PostalCode
String. Postal code for property address.
Telephone
Property phone number.
PropertyAmenity
Array. Each instance is a specific amenity, such as type of breakfast, spa, or pool. Properties:
description: Type of amenity.
code: OTA code for amenity.
category: Category of amenity.
BusinessService
Any business services available at the property. Properties:
code: OTA code for this type of business service.
description: Text string description of the business service.
Attraction
Array. Each instance is one attraction near the property. Properties:
name: Name of attraction.
Includes Distance object.
Distance
The distance of the attraction from the property. Properties:
value: Numeric distance.
unitOfDistance: Unit of the distance, either kilometers or miles.
CheckInOutPolicy
Property check in and out times. Properties:
checkInTime: Check in time of property.
checkOutTime: Check out time of property.
minimumAge: Minimum age to reserve room.
May include Description object.
Description
Array. Any free text related to the check in/out policy. Properties:
value: Free text provided by the supplier.
Example
{
"PropertiesResponse": {
"Properties": {
"@type": "Properties",
"PropertyInfo": [
{
"@type": "PropertyInfo",
"id": "XV-89550",
"Distance": {
"value": 7.88,
"unitOfDistance": "Miles"
},
"Property": {
"@type": "PropertyDetail",
"id": "XV-89550",
"PropertyKey": {
"@type": "PropertyKey",
"chainCode": "XV",
"propertyCode": "89550"
},
"name": "SpringHill Suites by Marriott Grand Rapids Airport Southeast",
"Rating": [
{
"value": 3,
"provider": "AAA"
},
{
"value": 2,
"provider": "NTM"
},
{
"value": 3,
"provider": "Booking"
},
{
"value": 3,
"provider": "GIATA"
}
],
"GeoLocation": {
"latitude": 42.907361,
"longitude": -85.539328
},
"Image": [
{
"value": "https://lucidcm.imgix.net/95559/Hotel/16748/Image/IoH3TT2Mka1A80f30dHyQ_Exterior%2025075.sh-grrse-exterior-25075:Classic-Hor?h=320&w=480",
"dimensionCategory": "L",
"caption": "Exterior",
"pictureCategory": 1
},
{
"value": "https://lucidcm.imgix.net/95559/Hotel/16748/Image/rmTyzGxOoEmCL7x3mhovHw_Front%20Desk%2028818.sh-grrse-front-desk-28818:Classic-Hor?h=320&w=480",
"dimensionCategory": "L",
"caption": "Front Desk",
"pictureCategory": 2
},
{
"value": "https://lucidcm.imgix.net/95559/Hotel/16748/Image/DZnrLnYf06MH9JPcud2EA_King%20Suite%20with%20Trundle35.sh-grrse-king-suite-with-trundle35-27632:Classic-Hor?h=320&w=480",
"dimensionCategory": "L",
"caption": "Living Space in King Suite",
"pictureCategory": 20
},
{
"value": "https://lucidcm.imgix.net/95559/Hotel/16748/Image/hk1ENwtjw0W6du55mlMXFg_King%20Suite%2038581.sh-grrse-king-suite-38581-76835:Classic-Hor?h=320&w=480",
"dimensionCategory": "L",
"caption": "King Suite with Trundle Sofa Bed",
"pictureCategory": 21
},
{
"value": "https://lucidcm.imgix.net/95559/Hotel/16748/Image/gV0QHnjdD0aCtQPZyp2Q_%202%20Queen%20Suite%2040021.sh-grrse--2-queen-suite-40021-87546:Classic-Hor?h=320&w=480",
"dimensionCategory": "L",
"caption": "2 Queen Suite with Trundle Bed Sofa",
"pictureCategory": 21
},
{
"value": "https://lucidcm.imgix.net/95559/Hotel/16748/Image/QM9LbZWjPEGbMCNDKJkzxw_Trundle%20Sofa%20Bed%2026603.sh-grrse-trundle-sofa-bed-26603:Classic-Hor?h=320&w=480",
"dimensionCategory": "L",
"caption": "Trundle Sofa Bed",
"pictureCategory": 21
},
{
"value": "https://lucidcm.imgix.net/95559/Hotel/16748/Image/hN3xeyQ7UGdVWfBCJgkeA_Standard%20Shower%2031759.sh-grrse-standard-shower-31759:Classic-Hor?h=320&w=480",
"dimensionCategory": "L",
"caption": "Standard Shower",
"pictureCategory": 21
},
{
"value": "https://lucidcm.imgix.net/95559/Hotel/16748/Image/0NRjl0PERUyU2ewyiKTlOQ_Mobility%20Accessible%20Tub27.sh-grrse-mobility-accessible-tub27-90141:Classic-Hor?h=320&w=480",
"dimensionCategory": "L",
"caption": "Mobility Accessible Tub",
"pictureCategory": 21
},
{
"value": "https://lucidcm.imgix.net/95559/Hotel/16748/Image/Awwr7oZc0Ost6YGntmsow_Roll%20In%20Shower%2037626.sh-grrse-roll-in-shower-37626:Classic-Hor?h=320&w=480",
"dimensionCategory": "L",
"caption": "Roll In Shower",
"pictureCategory": 21
},
{
"value": "https://lucidcm.imgix.net/95559/Hotel/16748/Image/Py3IBs3toUaDCwBkl38yqQ_Business%20Center%2025327.sh-grrse-business-center-25327:Classic-Hor?h=320&w=480",
"dimensionCategory": "L",
"caption": "Business Center",
"pictureCategory": 23
},
{
"value": "https://lucidcm.imgix.net/95559/Hotel/16748/Image/kz2h6lW23E6Hkj0FchBuQ_grrse-market-7009.jpg?h=320&w=480",
"dimensionCategory": "L",
"caption": "The Market",
"pictureCategory": 22
},
{
"value": "https://lucidcm.imgix.net/95559/Hotel/16748/Image/fiA6lQOHtkSwLBfRHXltBw_Breakfast%20Area%2027921-693.sh-grrse-breakfast-area-27921-693:Classic-Hor?h=320&w=480",
"dimensionCategory": "L",
"caption": "Breakfast Area",
"pictureCategory": 4
},
{
"value": "https://lucidcm.imgix.net/95559/Hotel/16748/Image/KWsbKG7FZECqIi54mCjFLw_Bar%2014381.sh-grrse-bar-14381:Classic-Hor?h=320&w=480",
"dimensionCategory": "L",
"caption": "Bar",
"pictureCategory": 13
},
{
"value": "https://lucidcm.imgix.net/95559/Hotel/16748/Image/u68yXo5qa0CRffNigxwslg_Breakfast%20Area%2027921.sh-grrse-breakfast-area-27921:Classic-Hor?h=320&w=480",
"dimensionCategory": "L",
"caption": "Breakfast Area",
"pictureCategory": 4
},
{
"value": "https://lucidcm.imgix.net/95559/Hotel/16748/Image/JztBYpRTvkak6p6JECRNA_Pool%2038340.sh-grrse-pool-38340:Classic-Hor?h=320&w=480",
"dimensionCategory": "L",
"caption": "Indoor Pool",
"pictureCategory": 3
},
{
"value": "https://lucidcm.imgix.net/95559/Hotel/16748/Image/0CMN1Wt9AU6TjS4KfgkWHQ_Fitness%20Center%2019355.sh-grrse-fitness-center-19355:Classic-Hor?h=320&w=480",
"dimensionCategory": "L",
"caption": "Fitness Center",
"pictureCategory": 5
},
{
"value": "https://lucidcm.imgix.net/95559/Hotel/16748/Image/bhkEDcZbkuuotNpiifERg_Fitness%20Center%2014048.sh-grrse-fitness-center-14048:Classic-Hor?h=320&w=480",
"dimensionCategory": "L",
"caption": "Fitness Center",
"pictureCategory": 5
},
{
"value": "https://lucidcm.imgix.net/95559/Hotel/16748/Image/kXfCXinyQESSbEemA7rbYQ_Meeting%20Space%2033659.sh-grrse-meeting-space-33659:Classic-Hor?h=320&w=480",
"dimensionCategory": "L",
"caption": "Meeting Space",
"pictureCategory": 8
},
{
"value": "https://lucidcm.imgix.net/95559/Hotel/16748/Image/5tcq4xofrEDasmyZ7hd0A_Boardroom%2014717.sh-grrse-boardroom-14717:Classic-Hor?h=320&w=480",
"dimensionCategory": "L",
"caption": "Boardroom",
"pictureCategory": 8
},
{
"value": "https://lucidcm.imgix.net/95559/Hotel/16748/Image/EJ1XnhlgzEGUE1fWYUjp7w_Queen%20Suite%20w%20Trundle2652.sh-grrse-queen-suite-w-trundle2652-91583:Classic-Hor?h=320&w=480",
"dimensionCategory": "L",
"caption": "2 Queen Suite with Trundle Sofa Bed",
"pictureCategory": 21
}
],
"Description": [
"Located minutes from the Gerald R. Ford International Airport, downtown and Lake Michigan beaches, the SpringHill Suites Grand Rapids Airport Southeast is ideal for corporate travel or fun weekend getaways. Our hotel near Grand Rapids airport offers great amenities like wireless Internet and a 24-hour food market. Up to 25% more spacious than traditional hotel rooms, our guest rooms feature separate eating and sleeping areas, pullout sofa, luxurious bedding, 32-inch TV, microwave, refrigerator, and wet bar. Staying fit is easy with our on-site fitness room and indoor pool. Start your morning with our new complimentary breakfast buffet and unwind in the evenings at our lobby bar (52fifty). When looking for affordable and spacious accommodations for short or extended stays, you will find an ideal choice at our Marriott hotel in Grand Rapids, Michigan."
],
"BusinessService": [
{
"code": "52",
"description": "Incoming fax complimentary"
},
{
"code": "67",
"description": "Ethernet connectivity"
},
{
"code": "96",
"description": "Meeting facilities"
},
{
"code": "33",
"description": "Telephone"
},
{
"code": "34",
"description": "Voicemail"
},
{
"code": "10",
"description": "Free toll free calls"
},
{
"code": "1",
"description": "Computer"
},
{
"code": "28",
"description": "Printer"
},
{
"code": "57",
"description": "Network/internet printing available"
},
{
"code": "2",
"description": "Copier"
},
{
"code": "64",
"description": "Post/parcel service"
},
{
"code": "62",
"description": "Overnight delivery/pickup"
},
{
"code": "9",
"description": "Fax machine"
}
],
"AccessibilityFeature": [
{
"value": "29",
"description": "Service animals allowed on property for people with disabilities"
},
{
"value": "69",
"description": "Service dogs allowed"
},
{
"value": "32",
"description": "Toilet seat in guest rooms for disabled person"
},
{
"value": "52",
"description": "Raised toilet seat with grab bars"
},
{
"value": "110",
"description": "Roll-in shower available"
},
{
"value": "38",
"description": "Grab bars in bathroom"
},
{
"value": "8",
"description": "Does hotel have accessible parking?"
}
],
"GuestRoomInfo": [
{
"@type": "GuestRoomInfo",
"code": "3",
"number": 109,
"description": "Suites"
},
{
"@type": "GuestRoomInfo",
"code": "28",
"number": 109,
"description": "Total rooms and suites"
},
{
"@type": "GuestRoomInfo",
"code": "2",
"number": 109,
"description": "Nonsmoking rooms"
},
{
"@type": "GuestRoomInfo",
"code": "5",
"number": 3,
"description": "Floors"
}
],
"Address": {
"@type": "Address",
"AddressLine": [
"5250 28th St. SE"
],
"City": "Grand Rapids",
"StateProv": {
"value": "MI"
},
"Country": {
"value": "US",
"name": "United States"
},
"PostalCode": "49512 "
},
"Telephone": [
"616-464-1130",
"464-1130"
],
"Email": {
"value": "shs.grrse.gm@test.com"
},
"PropertyAmenity": [
{
"@type": "PropertyAmenity",
"description": "Check cashing policy",
"code": "17",
"category": "Banking Services"
},
{
"@type": "PropertyAmenity",
"description": "Direct dial telephone",
"code": "109",
"category": "Business Services"
},
{
"@type": "PropertyAmenity",
"description": "Wedding services",
"code": "104",
"category": "Meeting Facilities"
},
{
"@type": "PropertyAmenity",
"description": "Elevators",
"code": "33",
"category": "Elevators"
},
{
"@type": "PropertyAmenity",
"description": "Front desk",
"code": "148",
"category": "24-Hour Front Desk"
},
{
"@type": "PropertyAmenity",
"description": "24-hour front desk",
"code": "1",
"category": "24-Hour Front Desk"
},
{
"@type": "PropertyAmenity",
"description": "Security",
"code": "80",
"category": "Security Services"
}
],
"CheckInOutPolicy": {
"checkInTime": "15:00:00"
}
}
}
]
},
"traceId": "ae5f98d5-87ce-4406-8b9c-eda519d5e324"
}
}