Skip to main content

Hotels

PropertyData TypeDescription
idStringSearch ID that represents the search session.
searchTypeStringValid values: HOTEL, DISTRICT, CITY
districtIdNumberdistrict ID, used when searching for hotels in a
hotelIdNumberused when searching for a specific hotel
cityCodeStringIATA location code
countryCodeStringcountry code
cityObjectCity object, returned by the API
worldRegionObjectWorldRegion object, returned by the API
countryObjectCountry object, returned by the API
roomsCountNumbernumber of rooms
guestsCountNumbernumber of guests
checkInStringcheck-in date in ISO 8601
checkOutStringcheck-out date in ISO 8601
localeStringlanguage to be used for translated values
siteCodeStringside code of request's origin
currencyCodeStringselected currency code to be used when for the rates
deviceTypeString
appTypeString.

Hotel

PropertyData TypeDescription
idNumberhotel ID
nameStringtranslated name, falls back to english if there is no available translation
starNumberhotel rating
imagesNumberhotel images
imagesCountNumbertotal number of images
propertyTypeIdNumberreference to property type object
brandIdNumberreference to brand object.
chainIdNumberreference to chain object.
districtIdNumberreference to district object.
amenityIdsNumberreferences to amenity objects
longitudeNumber
latitudeNumber.

Rate

PropertyData TypeDescription
idStringrate id
hotelIdNumberreference to the hotel object where this rate belongs to
providerCodeStringReference to provider object, where this rate belongs to
descriptionStringtranslated rate description, falls back to english if there is no available translation
rateAmenityIdsArrayreferences to rate amenity objects
remainingRoomsCountStringremaining room count
handoffUrlStringhand off url
usualPriceStringprice object, this is the usual price based on Wego data.

Price

PropertyData TypeDescription
amountNumberaverage amount of the rate
currencyCodeStringcurrency of the amount / totalAmount
amountUsdNumberaverage amount of the rate in USD
taxAmountNumbertax amount
taxAmountUsdNumbertax amount in USD
taxInclusiveBooleanindicates whether price includes tax or not
ecpcNumber
localTaxAmountNumberlocal tax amount
totalAmountNumbertotal amount
totalAmountUsdNumbertotal amount in USD

Provider

PropertyData TypeDescription
idStringprovider ID
codeStringprovider code
nameStringprovider name
typeStringOTA, DIRECT, OTA, DIRECT_PRIORITY
isMobileFriendlyBooleanIndicates whether provider's booking page is mobile friendly or not
isHotelWebsiteBooleanIndicates whether provider is hotel or not

RateAmenity

Not to be confused with amenity. This rate amenity is the object being referenced in rateAmenities inside Rate object.

PropertyData TypeDescription
idNumberrate amenity ID
codeStringrate amenity code
nameStringtranslated name, falls back to english if there is no available translation

Amenity

PropertyData TypeDescription
idNumberamenity ID
nameStringtranslated name, falls back to english if there is no available translation

District

PropertyData TypeDescription
idNumberDistrict ID
nameStringtranslated name, falls back to english if there is no available translation

Brand

PropertyData TypeDescription
idNumberBrand ID
nameStringtranslated name, falls back to english if there is no available translation

Chain

PropertyData TypeDescription
idNumberChain ID
nameStringtranslated name, falls back to english if there is no available translation

PropertyType

PropertyData TypeDescription
idNumberproperty ID
nameStringtranslated name, falls back to english if there is no available translation