Hotels
Search
| Property | Data Type | Description |
|---|---|---|
| id | String | Search ID that represents the search session. |
| searchType | String | Valid values: HOTEL, DISTRICT, CITY |
| districtId | Number | district ID, used when searching for hotels in a |
| hotelId | Number | used when searching for a specific hotel |
| cityCode | String | IATA location code |
| countryCode | String | country code |
| city | Object | City object, returned by the API |
| worldRegion | Object | WorldRegion object, returned by the API |
| country | Object | Country object, returned by the API |
| roomsCount | Number | number of rooms |
| guestsCount | Number | number of guests |
| checkIn | String | check-in date in ISO 8601 |
| checkOut | String | check-out date in ISO 8601 |
| locale | String | language to be used for translated values |
| siteCode | String | side code of request's origin |
| currencyCode | String | selected currency code to be used when for the rates |
| deviceType | String | |
| appType | String | . |
Hotel
| Property | Data Type | Description |
|---|---|---|
| id | Number | hotel ID |
| name | String | translated name, falls back to english if there is no available translation |
| star | Number | hotel rating |
| images | Number | hotel images |
| imagesCount | Number | total number of images |
| propertyTypeId | Number | reference to property type object |
| brandId | Number | reference to brand object. |
| chainId | Number | reference to chain object. |
| districtId | Number | reference to district object. |
| amenityIds | Number | references to amenity objects |
| longitude | Number | |
| latitude | Number | . |
Rate
| Property | Data Type | Description |
|---|---|---|
| id | String | rate id |
| hotelId | Number | reference to the hotel object where this rate belongs to |
| providerCode | String | Reference to provider object, where this rate belongs to |
| description | String | translated rate description, falls back to english if there is no available translation |
| rateAmenityIds | Array | references to rate amenity objects |
| remainingRoomsCount | String | remaining room count |
| handoffUrl | String | hand off url |
| usualPrice | String | price object, this is the usual price based on Wego data. |
Price
| Property | Data Type | Description |
|---|---|---|
| amount | Number | average amount of the rate |
| currencyCode | String | currency of the amount / totalAmount |
| amountUsd | Number | average amount of the rate in USD |
| taxAmount | Number | tax amount |
| taxAmountUsd | Number | tax amount in USD |
| taxInclusive | Boolean | indicates whether price includes tax or not |
| ecpc | Number | |
| localTaxAmount | Number | local tax amount |
| totalAmount | Number | total amount |
| totalAmountUsd | Number | total amount in USD |
Provider
| Property | Data Type | Description |
|---|---|---|
| id | String | provider ID |
| code | String | provider code |
| name | String | provider name |
| type | String | OTA, DIRECT, OTA, DIRECT_PRIORITY |
| isMobileFriendly | Boolean | Indicates whether provider's booking page is mobile friendly or not |
| isHotelWebsite | Boolean | Indicates 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.
| Property | Data Type | Description |
|---|---|---|
| id | Number | rate amenity ID |
| code | String | rate amenity code |
| name | String | translated name, falls back to english if there is no available translation |
Amenity
| Property | Data Type | Description |
|---|---|---|
| id | Number | amenity ID |
| name | String | translated name, falls back to english if there is no available translation |
District
| Property | Data Type | Description |
|---|---|---|
| id | Number | District ID |
| name | String | translated name, falls back to english if there is no available translation |
Brand
| Property | Data Type | Description |
|---|---|---|
| id | Number | Brand ID |
| name | String | translated name, falls back to english if there is no available translation |
Chain
| Property | Data Type | Description |
|---|---|---|
| id | Number | Chain ID |
| name | String | translated name, falls back to english if there is no available translation |
PropertyType
| Property | Data Type | Description |
|---|---|---|
| id | Number | property ID |
| name | String | translated name, falls back to english if there is no available translation |