What is it?
Robust descriptive information can be retrieved from the SynXis Platform using the Hotel Details or Hotel List methods.
- Hotel Details returns content for a single hotel.
- Hotel List returns content for multiple hotels.
Why use it?
Use the Hotel Details or Hotel List methods during the shopping and booking process to inform a guest about the detailed information about a hotel and answer questions they may have about the property.
How to use
The responses between the two methods are identical with the only exception is the number of hotels.
Hotel Details
GET https://[environment]/v1/api/hotel/{{hotel_Id}}/details Search for a single hotel.
Hotel List
GET https://[environment]/v1/api/hotel/list Search for multiple hotels using one of these methods:
- Address - city, state, postal code, country
- Destination - destination id that is defined in SynXis Control Center
- Id - one or more hotel ids
- Amenity - standalone search method or used in combination with any of the above options
Request Additional Content Additional Information can be returned in the response using the parameter @include and setting any of the supported values:
Attributes: Return a list of attributes for the hotel.ChannelProperties: Returns Channel properties of the hotel.ContactInfo: Return the contact information for the hotel.Currency: Return the default currency for the hotel.DiningOptions: Return a list of dining options for the hotel.Features: Return a list of property features for the hotel.HotelGroups: Return a list of Chains and Brands associated to the hotel.Images: Return a property level hotel image.Languages: Return a list of languages the hotel supports.LocationInfo: Return address, latitude/longitude and time zone information for the hotel.MealPlans: Return a list of meal plans for the hotel.MediaLibraryImages: Return the library of images.Messages: Return the messages and alerts.PaymentMethods: Return a list of payment methods the hotel supports.Recreations: Return a list of recreation information for the hotel.ReferencePoints: Return a list of reference points near the hotel.Services: Return a list of services for the hotel.Tier: Return the Hotel Tier Definition.Transportation: Return a list of Transportation for the hotel.
Note: Multiple selections can be requested using a comma as a delimiter (i.e. include=Attributes,DiningOptions,Features)
Sample Response
{
"contentLists": {
"croList": [{
"Chain": {
"Id": 12723
},
"Id": 14160760,
"Name": "FTC2"
}],
"currencyList": [{
"Code": "USD",
"Name": "US Dollars",
"DecimalPlaces": 2,
"RateOfExchange": "USD",
"Symbol": "$"
}],
"destinationList": [{
"Id": "14160638",
"Code": "BEACH",
"Name": "Beach Destinations"
}],
"paymentMethodList": [{
"Code": "MC",
"Name": "Mastercard",
"Type": "MC",
"Category": "CreditCard"
}, {
"Code": "AX",
"Name": "American Express",
"Type": "AX",
"Category": "CreditCard"
}],
"languageList": [{
"Code": "en-US",
"Name": "English - US",
"NativeName": "English - US"
}, {
"Code": "ja-JP",
"Name": "Japanese",
"NativeName": "日本語"
}],
"brandList": [{
"ID": 456,
"Name": "Sabre Hospitality Brand",
"ChainID": 12723
}],
"chainList": [{
"Code": "FAMORIM",
"ID": 12723,
"Name": "Sabre Hospitality Chain"
}]
},
"hotelList": [{
"ActiveDate": {
"StartDate": "2007-05-18",
"EndDate": "2027-09-29"
},
"AlertList": [{
"Details": {
"Description": "Pool Closed due to renovation",
"DetailedDescription": "The pool will be closed for renovation. During this time guests will not be able to enjoy it.",
"Validity": {
"Start": "2022-10-14T00:00:00",
"End": "2023-04-14T00:00:00"
}
},
"Name": "Pool Closed",
"Type": "Hotel"
}],
"Attributes": [{
"Id": 1412,
"Category": "LocalPolicies",
"Name": "Late Checkout",
"Value": "Late Checkout anytime",
"DataType": "String"
}, {
"Id": 1111,
"Category": "Location",
"Name": "Distance from closest train station to hotel",
"Value": "23",
"DataType": "Decimal"
}, {
"Id": 9089,
"Category": "PhysicallyChallengedFacilities",
"Name": "Width/diameter of main corridors",
"Value": "31",
"DataType": "String"
}],
"BrandList": [{
"ID": 456,
"Default": true
}],
"CROList": [{
"Id": 14160760
}],
"ChainList": [{
"ID": 513699,
"Primary": false
}, {
"ID": 12723,
"Primary": true
}],
"Channels": [{
"Code": "MobileWeb"
}, {
"Code": "CRS"
}, {
"Code": "WEB"
}, {
"Code": "IDS"
}, {
"Code": "GDS"
}, {
"Properties": {
"HotelCode": "12345",
"ChainCode": "YX",
"GoLiveDate": "2016-06-08T00:00:00"
},
"Code": "1A"
}],
"ContactDetails": {
"ContactName": " ",
"ContactNumberList": [{
"Number": "5556054521",
"Type": "Fax"
}, {
"Number": "5556054519",
"Type": "Voice1"
}, {
"Number": "5556054520",
"Type": "Voice2"
}],
"EmailAddress": "hotelstaff@somehotel.com",
"Website": "www.somehotelwebsite.com"
},
"Currency": {
"Code": "USD",
"Name": "US Dollars",
"Default": true
},
"DestinationList": [{
"Id": 14160638
}],
"DiningOptionList": [{
"Category": {
"OtaCode": "9",
"OtaType": "RES",
"OtaDescription": "Fine dining"
},
"Meal": {
"Breakfast": true,
"Brunch": true,
"Dinner": true,
"Lunch": true
},
"Name": "Chez McPherson",
"Distance": "25",
"OnProperty": true,
"SmokingPermitted": true,
"Description": "Upscale Restaurant",
"SortOrder": 1
}],
"Location": {
"Address": {
"AddressLine": ["3150 Sabre Drive"],
"City": "Southlake",
"CountryName": {
"Code": "US",
"Value": "United States"
},
"PostalCode": "76092",
"StateProv": {
"Code": "TX",
"Value": "Texas"
}
},
"Latitude": 38.99033,
"Longitude": -77.09715,
"TimeZone": "-5",
"Type": "None"
},
"LanguageList": [{
"Code": "en-US",
"Default": true,
"Primary": true
}, {
"Code": "ja-JP",
"Default": false,
"Primary": true
}],
"MealPlanList": [{
"Name": "Full Board",
"Chargeable": false,
"Type": "American",
"Description": ""
}, {
"Name": "Room Only",
"Chargeable": false,
"Type": "RoomOnly",
"Description": ""
}],
"PaymentMethodList": [{
"Code": "MC",
"Deposit": true,
"Guarantee": true,
"InUse": true
}, {
"Code": "AX",
"Deposit": true,
"Guarantee": true,
"InUse": true
}],
"RecreationList": [{
"Type": "Antique shopping",
"Distance": "5",
"OnProperty": false,
"OtaCode": "152",
"OtaType": "RST",
"OtaDescription": "Antique shopping",
"Note": "Let's go shopping!"
}],
"ReferencePointList": [{
"Name": "Pikes Peak",
"Type": "Attraction",
"Direction": "N",
"Distance": "600",
"UnitOfMeasure": "miles"
}],
"ServiceList": [{
"Type": {
"Code": "BUS",
"Id": "39",
"Name": "Business Center"
},
"OnProperty": true,
"Note": ""
}, {
"Type": {
"Name": "Express Check-in Fee"
},
"OnProperty": true,
"Note": ""
}],
"PropertyFeatures": [{
"Code": "20514",
"Description": "Car rental desk",
"OtaCode": "15",
"OtaType": "HTA",
"OtaDescription": "Car rental desk"
}, {
"Code": "20760",
"Description": "High speed wireless",
"OtaCode": "261",
"OtaType": "HTA",
"OtaDescription": "High speed wireless"
}],
"Status": "Open",
"TerminalList": [{
"TransportationList": [{
"TransportationCode": "Bus",
"TransportationMethod": "Bus",
"OneWay": false,
"ArrangeableByHotel": true,
"Description": "Bus To/From Airport"
}],
"Code": "DCA",
"Type": "Airport"
}, {
"TransportationList": [],
"Code": "COS",
"Type": "Airport"
}],
"Code": "CRSPROD1",
"PmsCode": "13098",
"ID": "13098",
"Name": "Amorim Hotel",
"ShortName": "Amorim Hotel",
"ImageList": [{
"MediaType": "CRS",
"Caption": null,
"Path": "\\hotel\\13098\\Images\\Banner\\Sample.jpg",
"MediaCategory": "Banner",
"SortOrder": 0
}],
"Descriptions": [{
"Name": "Location",
"Description": "Location Information"
}, {
"Name": "Directions",
"Description": "Directions to the hotel"
}]
}]
}