Skip to main content

Hotel Content

Commerce
Hotel Descriptive Content
Shopping
Hotels
Descriptions
REST API
Booking Solutions

What is it?

With the Hotel Content API, you can use the endpoints to get robust descriptive information about a single hotel or multiple hotels. During the shopping and booking process, use the two endpoints (explained below) to inform guests about each hotel's details and to answer questions they may have about the property.

Before You Begin

  • You must authenticate before you can use this API. For full instructions, see Get a Token for REST APIs.
  • At any time, you can go to this API's Reference Documentation tab, where you can make test calls with the following endpoints.

How to use

This section covers the endpoints for this API and examples of how to use them.

GET details for one hotel #

This endpoint enables you to retrieve details for a hotel that you specify.

[GET] /v1/api/hotel/{id}/details

Path Parameters

The following table describes the path parameters that you must include when you query this endpoint:

ElementDescriptionTypeRequired?
idThe ID of the hotel for which you want to get details. Example: 13098.numberYes

Query Parameters

The following table describes the query parameters that you can include when you query this endpoint:

ElementDescriptionTypeRequired?
attributeCategoryYou can specify one or more attribute categories. Available values are: Unknown, GeneralFacilities, LocalPolicies, Location, PhysicallyChallengedFacilities, Ratings, Safety, Settings.arrayOptional

Note: All of the query parameters that this endpoint allows (except attributeCategory, explained above) are also allowed for the following endpoint. This endpoint also returns responses that are the same as the following endpoint. See the query parameters and response for the following endpoint for details.

▲ Back to top

GET details for multiple hotels #

This endpoint enables you to retrieve details for a list of hotels that you specify.

[GET] /v1/api/hotel/list

Query Parameters

The following table describes the elements that you can include when you query this endpoint:

ElementDescriptionTypeRequired?
brandIdThe ID of a specific brand in Aven Hospitality's SynXis Central Reservation System (CRS), which includes the hotels for which you want to get details. Example: 12345.numberNo
chainIdThe ID of the chain or management group of the hotels for which you want to get details. Example: 12723.numberYes
id

The IDs of the hotels for which you want to get details.

Example: Include multiple hotels separated by commas, like this &id=13098,16099.

arrayNo
addressCityThe city associated with a hotel address.stringNo
addressStateThe code of a state or province associated with an address. An ISO State/Prov code.stringNo
addressPostalCodeThe Postal code associated with a hotel address.stringNo
addressCountryThe country of the address. An ISO Alpha-2 letter alpha country code.stringNo
destinationIdThe ID associated with a destination in Aven Hospitality's SynXis Central Reservation System (CRS).stringNo
destinationCodeThe code associated with a destination in Aven Hospitality's SynXis Central Reservation System (CRS).stringNo
locationLatitudeThe latitude coordinate to use in the search for hotels.numberNo
locationLongitudeThe longitude coordinate to use in the search for hotels.numberNo
locationRadiusThe radius to use in a latitude / longitude search for hotels.numberNo
locationUnitsThe unit of measurement for the radius. Available values are: miles, kilometers.stringNo
airportCodeThe valid IATA airport code.stringNo
primaryChannelThe booking channel code from Aven Hospitality's SynXis Central Reservation System (CRS). Example: WebstringNo
include

Specifies the additional information that you want to include in the response.

Example: Include multiple attributes separated by commas, like this &include=Transportation,Tier.

Note: See the list of values below that you can use with the include parameter.

stringNo

The following is the list of values that you can use with the include parameter:

• Attributes: Return a list of attributes for the hotel.

• ChannelProperties: Return 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.

Note: Within MealPlans, the AvailableToAnyGuest attribute specifies whether the meal plan is available to all guests (true) or available to only certain groups of guests (false).

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

Response in JSON

{
  "contentLists": {
    "destinationList": [
      {
        "Id": "string",
        "Code": "string",
        "Name": "string"
      }
    ],
    "currencyList": [
      {
        "Code": "string",
        "Name": "string",
        "DecimalPlaces": 0,
        "RateOfExchange": "string",
        "Symbol": "string"
      }
    ],
    "croList": [
      {
        "Id": "string",
        "Name": "string",
        "Chain": {
          "Id": "string"
        }
      }
    ],
    "brandList": [
      {
        "Code": "string",
        "ID": "string",
        "Name": "string",
        "ChainID": "string"
      }
    ],
    "languageList": [
      {
        "Code": "string",
        "Name": "string",
        "NativeName": "string"
      }
    ],
    "paymentMethodList": [
      {
        "Code": "string",
        "Name": "string",
        "Type": "AL",
        "Category": "string",
        "IsPassThru": true
      }
    ],
    "chainList": [
      {
        "Code": "string",
        "ID": "string",
        "Name": "string"
      }
    ]
  },
  "hotelList": [
    {
      "ActiveDate": {
        "StartDate": "2026-04-30",
        "EndDate": "2026-04-30"
      },
      "AlertList": [
        {
          "Name": "string",
          "Type": "BookingInfo",
          "Details": {
            "Description": "string",
            "DetailedDescription": "string",
            "Validity": {
              "End": "2026-04-30",
              "Start": "2026-04-30"
            }
          }
        }
      ],
      "Attributes": [
        {
          "Category": "LocalPolicies",
          "Id": 0,
          "Name": "string",
          "Value": "string",
          "DataType": "string"
        }
      ],
      "BrandList": [
        {
          "ID": "string",
          "Default": true
        }
      ],
      "CROList": [
        {
          "Id": "string"
        }
      ],
      "ChainList": [
        {
          "ID": "string",
          "Primary": true
        }
      ],
      "Channels": [
        {
          "Code": "string",
          "Name": "string",
          "ParentCode": "string",
          "EnabledForDistribution": true,
          "IsDefaultGroupChannel": true,
          "IsChannelEnabledForGroups": true,
          "Properties": {
            "HotelCode": "string",
            "ChainCode": "string",
            "GoLiveDate": "2026-04-30"
          }
        }
      ],
      "ContactDetails": {
        "ContactName": "string",
        "ContactNumberList": [
          {
            "Number": "string",
            "Type": "Home"
          }
        ],
        "EmailAddress": "string",
        "Website": "string"
      },
      "Currency": {
        "Code": "string",
        "Name": "string",
        "Default": true
      },
      "DestinationList": [
        {
          "Id": "string"
        }
      ],
      "DiningOptionList": [
        {
          "Description": "string",
          "Name": "string",
          "OnProperty": true,
          "SmokingPermitted": true,
          "Distance": "string",
          "Meal": {
            "Breakfast": true,
            "Brunch": true,
            "Dinner": true,
            "Lunch": true
          },
          "Category": [
            {
              "OtaCode": "string",
              "OtaType": "string",
              "OtaDescription": "string"
            }
          ],
          "SortOrder": 0
        }
      ],
      "Location": {
        "Address": {
          "AddressLine": [
            "string"
          ],
          "City": "string",
          "CountryName": {
            "code": "string",
            "value": "string"
          },
          "PostalCode": "string",
          "StateProv": {
            "code": "string",
            "value": "string"
          }
        },
        "Latitude": "string",
        "Longitude": "string",
        "TimeZone": "string",
        "Type": "None"
      },
      "LanguageList": [
        {
          "Code": "string",
          "Default": true,
          "Primary": true
        }
      ],
      "MealPlanList": [
        {
          "Name": "Bed and Breakfast",
          "Type": "Continental",
          "Chargeable": true,
          "Description": "Breakfast included in all rates. Buffet Breakfast served in the main restaurant 6-10 am.",
          "AvailableToAnyGuest": true
        }
      ],
      "PaymentMethodList": [
        {
          "Code": "string",
          "Deposit": true,
          "Guarantee": true,
          "InUse": true,
          "IsPassThru": true
        }
      ],
      "RecreationList": [
        {
          "Type": "string",
          "OnProperty": true,
          "Distance": 0,
          "Note": "string",
          "OtaCode": "string",
          "OtaDescription": "string",
          "OtaType": "string"
        }
      ],
      "ReferencePointList": [
        {
          "Name": "string",
          "Type": "Attraction",
          "Direction": "E",
          "Distance": 0,
          "UnitOfMeasure": "None"
        }
      ],
      "RelativeLocation": {
        "AnchorLatitude": 0,
        "AnchorLongitude": 0,
        "Distance": 1000,
        "Unit": "Kilometers",
        "Orientation": "East",
        "OriginalHotel": [
          {
            "Id": "Unknown Type: int"
          }
        ]
      },
      "ServiceList": [
        {
          "OnProperty": true,
          "Note": "string",
          "Type": {
            "Code": "string",
            "Id": 0,
            "Name": "string"
          }
        }
      ],
      "PropertyFeatures": [
        {
          "Code": "string",
          "Description": "string",
          "OtaCode": "string",
          "OtaDescription": "string",
          "OtaType": "string"
        }
      ],
      "Status": "Open",
      "TerminalList": [
        {
          "Code": "string",
          "Type:": "Airport",
          "TransportationList": [
            {
              "TransportationCode": "string",
              "TransportationMethod": "Alternate",
              "OneWay": true,
              "ArrangeableByHotel": true,
              "Description": "string"
            }
          ]
        }
      ],
      "Tier": {
        "Code": "string",
        "Name": "string"
      },
      "Code": "string",
      "PmsCode": "string",
      "ID": 0,
      "Name": "string",
      "ShortName": "string",
      "ImageList": [
        {
          "Caption": "Ocean View",
          "Path": "https://hotel.cloudfront.net/imageRepo/1/OceanView.jpg",
          "Description": "Restaurant with Ocean View",
          "SortOrder": 1,
          "MediaType": "CRS",
          "MediaCategory": "Rate"
        }
      ],
      "Descriptions": [
        {
          "Name": "string",
          "Description": "string"
        }
      ]
    }
  ],
  "paging": {
    "Size": 50,
    "Start": 0,
    "Total": 146
  }
}

Response Elements

The following table explains the elements you receive in the response.

To make the response structure easier to follow, this table prefixes every element with the object and array structure that contains it, like this: ArrayOne.ArrayTwo.ArrayThree.Element

ElementDescriptionType
contentListsThe object to hold all the hotel content list information.object
contentLists.destinationListThe array to hold the destination list information.array
contentLists.destinationList.IdUnique ID that identifies a specific Destination in Aven Hospitality's SynXis Central Reservation System (CRS).string
contentLists.destinationList.CodeCode of a destination.string
contentLists.destinationList.NameName of a destination.string
contentLists.currencyListThe array to hold the currency list information.array
contentLists.currencyList.CodeThe currency code in ISO 4217 three alpha format. Example: USD.string
contentLists.currencyList.NameName of the currency.string
contentLists.currencyList.DecimalPlacesNumber of decimals supported by the currency.number
contentLists.currencyList.RateOfExchangeRate of exchange for the currency.string
contentLists.currencyList.SymbolSymbol of the currency.string
contentLists.croListThe array to hold the Central Reservations Office (CRO) list information.array
contentLists.croList.IdUnique ID that identifies a specific CRO in Aven Hospitality's SynXis Central Reservation System (CRS).string
contentLists.croList.NameName of a CRO.string
contentLists.croList.ChainThe object to hold the CRO list chain information.object
contentLists.croList.Chain.IdID of the Chain that the CRO is associated with.string
contentLists.brandListThe array to hold the brand list information.array
contentLists.brandList.CodeCode identifying the hotel or chain brand.string
contentLists.brandList.IDUnique ID that identifies a specific brand in Aven Hospitality's SynXis Central Reservation System (CRS).string
contentLists.brandList.NameName of a hotel or chain brand.string
contentLists.brandList.ChainIDID of the Chain that the brand is associated with.string
contentLists.languageListThe array to hold the language list information.array
contentLists.languageList.CodeLanguage code with an optional culture code. For example: en or en-us.string
contentLists.languageList.NameName of the language.string
contentLists.languageList.NativeNameNative Name for the language.string
contentLists.paymentMethodListThe array to hold the payment method list information.array
contentLists.paymentMethodList.CodeStandard code for the payment type.string
contentLists.paymentMethodList.NameName of the payment type.string
contentLists.paymentMethodList.TypeThis is the type of the payment method. Available values are: AL, ATMDC, AX, BA, BO, CB, CC, CH, CK, DB, DC, DK, DS, EC, ER, EU, FB, GW, HI, ID, IP, JC, KB, LPC, LPP, MA, MC, MD, NB, PP, TA, TP, UP, UPE, Unknown, VI, WA, WC, XS.string
contentLists.paymentMethodList.CategoryPayment method category.string
contentLists.paymentMethodList.IsPassThruIf this is true, the payment method is a pass-through payment method. If this is false, the payment method is not a pass-through payment method.boolean
contentLists.chainListThe array to hold the chain list information.array
contentLists.chainList.CodeCode that defines a hotel chain or management group in Aven Hospitality's SynXis Central Reservation System (CRS).string
contentLists.chainList.IDUnique ID that identifies a hotel chain or management group in Aven Hospitality's SynXis Central Reservation System (CRS).string
contentLists.chainList.NameName of the hotel chain.string
hotelListThe array to hold the hotel list information.array
hotelList.ActiveDateThe object to hold the hotel's active date information.object
hotelList.ActiveDate.StartDateBeginning date that the hotel is active.string
hotelList.ActiveDate.EndDateDate that the hotel was terminated from CRS.string
hotelList.AlertListThe array to hold the alert list information.array
hotelList.AlertList.NameName of the alert.string
hotelList.AlertList.TypeThe type of the alert. Available values are: BookingInfo, Hotel, Marketing.string
hotelList.AlertList.DetailsThe object to hold the alert list details.object
hotelList.AlertList.Details.DescriptionShort description of the alert.string
hotelList.AlertList.Details.DetailedDescriptionDetailed description of the alert.string
hotelList.AlertList.Details.ValidityThe object to hold the validity information for the alert.object
hotelList.AlertList.Details.Validity.EndEnd date for which the alert applies.string
hotelList.AlertList.Details.Validity.StartStart date for which the alert applies.string
hotelList.AttributesThe array to hold the hotel attributes.array
hotelList.Attributes.CategoryCategory code of the attribute. Available values are: LocalPolicies, Location, GeneralFacilities, PhysicallyChallengedFacilities, Ratings, Safety.string
hotelList.Attributes.IdCRS ID of the attribute.integer
hotelList.Attributes.NameName of the attribute.string
hotelList.Attributes.ValueValue of the attribute.string
hotelList.Attributes.DataTypeData type associated to the specific attribute.string
hotelList.BrandListThe array to hold the brand list information.array
hotelList.BrandList.IDUnique ID that identifies a specific brand in CRS.string
hotelList.BrandList.DefaultIf this is true, the brand is the default brand for the hotel. If this is false, the brand is not the default brand for the hotel.boolean
hotelList.CROListThe array to hold the Central Reservations Office (CRO) list information.array
hotelList.CROList.IdUnique Id that identifies a CRO or management group in Aven Hospitality's SynXis Central Reservation System (CRS).string
hotelList.ChainListThe array to hold the chain list information.array
hotelList.ChainList.IDUnique ID that identifies a hotel chain or management group in CRS.string
hotelList.ChainList.PrimaryIf this is true, the chain is the primary chain for the hotel. If this is false, the chain is not the primary chain for the hotel.boolean
hotelList.ChannelsThe array to hold the channels information.array
hotelList.Channels.CodeChannel code of the channel to which the hotel is assigned.string
hotelList.Channels.NameDisplay name of the channel to which the hotel is assigned.string
hotelList.Channels.ParentCodeParent channel code of the channel to which the hotel is assigned.string
hotelList.Channels.EnabledForDistributionIf this is true, the channel allows channel distribution. If this is false, the channel does not allow channel distribution.boolean
hotelList.Channels.IsDefaultGroupChannelIf this is true, the channel is a default group channel. If this is false, the channel is not a default group channel.boolean
hotelList.Channels.IsChannelEnabledForGroupsIf this is true, the channel is enabled for group bookings. If this is false, the channel is not enabled for group bookings.boolean
hotelList.Channels.PropertiesThe object to hold the properties.object
hotelList.Channels.Properties.HotelCodeThe channel specific hotel code.string
hotelList.Channels.Properties.ChainCodeThe channel specific chain codestring
hotelList.Channels.Properties.GoLiveDateThe Go-Live date of the hotel for this channel.string
hotelList.ContactDetailsThe object to hold the hotel contact details.object
hotelList.ContactDetails.ContactNameThe name of the contact.string
hotelList.ContactDetails.ContactNumberListThe array to hold the contact number information.array
hotelList.ContactDetails.ContactNumberList.NumberPhone number for the contact.string
hotelList.ContactDetails.ContactNumberList.TypeThe type of contact number. Available values are: Home, Office, Mobile, Fax, Voice1.string
hotelList.ContactDetails.EmailAddressEmail address for the contact.string
hotelList.ContactDetails.WebsiteWebsite URL for the hotel.string
hotelList.CurrencyThe object to hold the currency information.object
hotelList.Currency.CodeThe currency code in ISO 4217 three alpha format. Example: USD.string
hotelList.Currency.NameName of the currency.string
hotelList.Currency.DefaultIf this is true, the currency is the default currency of the hotel. If this is false, the currency is not the default currency of the hotel.boolean
hotelList.DestinationListThe array to hold the destination list information.array
hotelList.DestinationList.IdUnique ID that identifies a destination or management group in CRS.string
hotelList.DiningOptionListThe array to hold the dining option information.array
hotelList.DiningOptionList.DescriptionDescription of the dining option.string
hotelList.DiningOptionList.NameName of the dining option.string
hotelList.DiningOptionList.OnPropertyIf this is true, the dining option is located at the hotel. If this is false, the dining option is not located at the hotel.boolean
hotelList.DiningOptionList.SmokingPermittedIf this is true, smoking is permitted. If this is false, smoking is not permitted.boolean
hotelList.DiningOptionList.DistanceThis is the distance from the hotel to the dining option location.string
hotelList.DiningOptionList.MealThe object to hold the meal information.object
hotelList.DiningOptionList.Meal.BreakfastIf this is true, Breakfast is available. If this is false, Breakfast is not available.boolean
hotelList.DiningOptionList.Meal.BrunchIf this is true, Brunch is available. If this is false, Brunch is not available.boolean
hotelList.DiningOptionList.Meal.DinnerIf this is true, Dinner is available. If this is false, Dinner is not available.boolean
hotelList.DiningOptionList.Meal.LunchIf this is true, Lunch is available. If this is false, Lunch is not available.boolean
hotelList.DiningOptionList.CategoryThe array to hold the dining category information.array
hotelList.DiningOptionList.Category.OtaCodeOTA code of the dining option.string
hotelList.DiningOptionList.Category.OtaTypeOTA code category type.string
hotelList.DiningOptionList.Category.OtaDescriptionName of the OTA restaurant category.string
hotelList.DiningOptionList.SortOrderThe sort order of the dining options.integer
hotelList.LocationThe object to hold the hotel location information.object
hotelList.Location.AddressThe object to hold the hotel address.object
hotelList.Location.Address.AddressLineStreet-related information associated with the hotel.array
hotelList.Location.Address.CityCity where the hotel is located.string
hotelList.Location.Address.CountryNameThe object to hold the hotel country name information.object
hotelList.Location.Address.CountryName.codeCountry code where the hotel is located. ISO alpha-2 letter code.string
hotelList.Location.Address.CountryName.valueName of the country where the hotel is located.string
hotelList.Location.Address.PostalCodePostal code for the hotel.string
hotelList.Location.Address.StateProvThe object to hold the hotel state or province information.object
hotelList.Location.Address.StateProv.codeState or province where the hotel is located. ISO state or province code.string
hotelList.Location.Address.StateProv.valueName of the state or province where the hotel is located.string
hotelList.Location.LatitudeLatitude coordinate for the location of the hotel.string
hotelList.Location.LongitudeLongitude coordinate for the location of the hotel.string
hotelList.Location.TimeZoneTime zone (UTC) in which the hotel is located.string
hotelList.Location.TypeThe hotel location type. Available values are: None, Airport, CityCenter, Resort, Rural, Suburban.string
hotelList.LanguageListThe array to hold the language information.array
hotelList.LanguageList.CodeLanguage code with an optional culture code.string
hotelList.LanguageList.DefaultIf this is true, the language is the default language for the hotel. If this is false, the language is not the default language for the hotel.boolean
hotelList.LanguageList.PrimaryIf this is true, the language is the primary language for the hotel. If this is false, the language is not the primary language for the hotel.boolean
hotelList.MealPlanListThe array to hold the meal plan information.array
hotelList.MealPlanList.NameName of the meal plan.string
hotelList.MealPlanList.TypeType of breakfast. Available values are: American, BedBreakfast, Bermuda, CaribbeanPlan, Continental, DinnerBedBreakfast, European, FamilyAmerican, FullBreakfast, Family, Modified, RoomOnly, EnglishBreakfast, AllInclusive, BuffetBreakfast, Breakfast, LightBreakfast.string
hotelList.MealPlanList.ChargeableIf this is true, the meal plan is chargeable (meaning that it is not included in the room rate). If this is false, the meal plan is not chargeable (meaning that it is included in the room rate).boolean
hotelList.MealPlanList.DescriptionThis is a detailed description of the meal plan.string
hotelList.MealPlanList.AvailableToAnyGuestIf this is true, the meal plan is available to all guests. If this is false, the meal plan is available to only certain groups of guests.boolean
hotelList.PaymentMethodListThe array to hold the payment method information.array
hotelList.PaymentMethodList.CodeStandard code for the payment type.string
hotelList.PaymentMethodList.DepositIf this is true, the payment type is accepted for a deposit. If this is false, the payment type is not accepted for a deposit.boolean
hotelList.PaymentMethodList.GuaranteeIf this is true, the payment type is accepted for a guarantee. If this is false, the payment type is not accepted for a guarantee.boolean
hotelList.PaymentMethodList.InUseIf this is true, the payment type is active and in use by the hotel. If this is false, the payment type is not active and in use by the hotel.boolean
hotelList.PaymentMethodList.IsPassThruIf this is true, the payment method is a pass through payment method. If this is false, the payment method is not a pass through payment method.boolean
hotelList.RecreationListThe array to hold the recreation information.array
hotelList.RecreationList.TypeType of recreation.string
hotelList.RecreationList.OnPropertyIf this is true, the recreation type is on the hotel property. If this is false, the recreation type is not on the hotel property.boolean
hotelList.RecreationList.DistanceDistance from the hotel to the recreation location.number
hotelList.RecreationList.NoteThis is a note to include additional information about the recreation.string
hotelList.RecreationList.OtaCodeOTA code indicating the recreation type (HAC, REC, or RST).string
hotelList.RecreationList.OtaDescriptionOTA description of the recreation.string
hotelList.RecreationList.OtaTypeOTA code category type.string
hotelList.ReferencePointListThe array to hold the reference point information.array
hotelList.ReferencePointList.NameName of the reference point.string
hotelList.ReferencePointList.TypeThe type of the reference point. Available values are: Attraction, Business.string
hotelList.ReferencePointList.DirectionDirection from the reference point to the property. Available values are: E, N, NE, NW, S, SE, SW, W.string
hotelList.ReferencePointList.DistanceDistance from the reference point to the property.number
hotelList.ReferencePointList.UnitOfMeasureUnit of measurement. Available values are: None, Centimeters, Feet, Inches, Kilometers, Meters, Miles, Milimeters, Yards.string
hotelList.RelativeLocationThe object to hold the relative location information.object
hotelList.RelativeLocation.AnchorLatitudeThe latitude of the amenity's location.number
hotelList.RelativeLocation.AnchorLongitudeThe longitude of the amenity's location.number
hotelList.RelativeLocation.DistanceThe amenity's distance from the Original Hotel.int
hotelList.RelativeLocation.UnitThe unit of measure for the amenity's distance from the Original Hotel. Available values are: Kilometers, Miles.string
hotelList.RelativeLocation.OrientationThe orientation of the location of the amenity relative to the Original Hotel. Available values are: North, NorthEast, East, SouthEast, South, SouthWest, NorthWest.string
hotelList.RelativeLocation.OriginalHotelThe array to hold the Original Hotel information.array
hotelList.RelativeLocation.OriginalHotel.IdThe hotel that provides the amenity for which this array defines the relative location.int
hotelList.ServiceListThe array to hold the service information.array
hotelList.ServiceList.OnPropertyIf this is true, the service is located on the hotel property. If this is false, the service is not located on the hotel property.boolean
hotelList.ServiceList.NoteThis note can hold a brief description of the service or more details about the charges.string
hotelList.ServiceList.TypeThe object to hold the service type information.object
hotelList.ServiceList.Type.CodeHAC and BUS OTA Service code value.string
hotelList.ServiceList.Type.IdThe ID of the service.integer
hotelList.ServiceList.Type.NameName of the service amenity.string
hotelList.PropertyFeaturesThe array to hold the property features.array
hotelList.PropertyFeatures.CodeCode indicating the property feature.string
hotelList.PropertyFeatures.DescriptionDescription of the property feature.string
hotelList.PropertyFeatures.OtaCodeOTA code indicating the property feature.string
hotelList.PropertyFeatures.OtaDescriptionOTA description of the property feature.string
hotelList.PropertyFeatures.OtaTypeOTA code category type.string
hotelList.StatusActive status of the hotel. Available values are: Open, Inactive, Suspended, Terminated.string
hotelList.TerminalListThe array to hold the terminal information.array
hotelList.TerminalList.CodeIndicates the Terminal Codestring
hotelList.TerminalList.Type:Indicates the Terminal Type. Available values are: Airport, Boatdock, BusTerminal, TrainStation, Unknown.string
hotelList.TerminalList.TransportationListThe array to hold the transportation information.array
hotelList.TerminalList.TransportationList.TransportationCodeThe Transportation Code.string
hotelList.TerminalList.TransportationList.TransportationMethodThe Transportation Method. Available values are: Alternate, Boat, Bus, CarRental, Limo, MetroSubway, Other, Shuttle, Taxi, Train.string
hotelList.TerminalList.TransportationList.OneWayIf this is true, the transportation is a one way trip. If this is false, the transportation is not a one way trip.boolean
hotelList.TerminalList.TransportationList.ArrangeableByHotelIf this is true, the hotel can arrange the transportation. If this is false, the hotel cannot arrange the transportation.boolean
hotelList.TerminalList.TransportationList.DescriptionDescription of the transportation method.string
hotelList.TierThe object to hold the hotel tier information.object
hotelList.Tier.CodeThe code for the tier of the hotel.string
hotelList.Tier.NameThe name for the tier of the hotel.string
hotelList.CodeThe code to identify a specific hotel.string
hotelList.PmsCodeThe PMS code to identify a specific hotel.string
hotelList.IDThe ID that uniquely identifies a single hotel property in CRS.integer
hotelList.NameName of the hotel.string
hotelList.ShortNameThe short name of the hotel.string
hotelList.ImageListThe array to hold the image information.array
hotelList.ImageList.CaptionCaption of the image.string
hotelList.ImageList.PathURL to the image file.string
hotelList.ImageList.DescriptionDescription of the image (ICE Portal images only).string
hotelList.ImageList.SortOrderSpecifies the sequence in which the search results are displayed.integer
hotelList.ImageList.MediaTypeMedia type of the image. Available values are: CRS, VScape, ICE Portal.string
hotelList.ImageList.MediaCategoryMedia category associated to the image.string
hotelList.DescriptionsThe array to hold the descriptions.array
hotelList.Descriptions.NameName related to the description.string
hotelList.Descriptions.DescriptionDetailed description.string
pagingThe object to hold the API paging information.object
paging.SizeNumber of records to be returned in the response (0 = return all)integer
paging.StartStarting record to be returned in the response.integer
paging.TotalTotal number of records.integer

▲ Back to top