GetHotelsResponse
GetHotelsResponse returns hotel catalog entries for the requested scope.
auditData object
Request audit information and downstream trace ids.
Identifier supplied by the caller to correlate the request.
transactions object[]
Downstream transactions performed during the request lifecycle.
Access identifier used for the provider call.
Raw request payload captured for auditing.
Raw response payload captured for auditing.
Identifier of the transaction within the aggregator.
Duration in milliseconds for the provider call.
Target URL of the provider call.
HTTP status code returned by the provider.
httpResponseHeaders object
HTTP headers returned by the provider.
errors object[]
Blocking errors encountered while fetching hotel data.
Error type grouping to help the client react appropriately.
Possible values: [ERR_TYPE_NONE, ERR_TYPE_UNKNOWN, ERR_TYPE_CLIENT, ERR_TYPE_PROVIDER, ERR_TYPE_SERVICE]
Specific error code exposed by the aggregator.
Possible values: [ERR_CODE_NONE, ERR_CODE_UNKNOWN, ERR_CODE_ACCESS_DATA_MISSING, ERR_CODE_BAD_RESPONSE, ERR_CODE_BAD_REQUEST, ERR_CODE_MISSING_FIELDS, ERR_CODE_CONFIGURATION]
Human readable description of the error.
additionalData object
Additional key/value data associated with the error.
Access identifier that produced the error when applicable.
warnings object[]
Non-blocking warnings returned alongside the hotel data.
Warning code categorising the issue.
Possible values: [WARN_CODE_NONE, WARN_MAPPING_HOTEL_MISSING, WARN_MAPPING_ROOM_MISSING, WARN_MAPPING_RATE_PLAN_MISSING, WARN_MAPPING_BOARD_CODE_MISSING]
Human readable warning description.
additionalData object
Additional key/value data associated with the warning.
Access identifier that produced the warning when available.
debugData object[]
Additional debug data for diagnostic purposes.
Type identifier that categorises the value.
Associated value.
hotels object[]
Hotel records that matched the request criteria.
Aggregator hotel identifier.
Display name for the hotel.
descriptions object[]
Additional textual descriptions provided for the hotel.
Description text.
ISO 639-1 language code for the description.
Hotel category code such as star rating.
Property type such as HOTEL, APARTMENT or HOSTEL.
Chain code associated with the property.
Board codes available for this hotel.
mandatoryFee object[]
Mandatory fees that apply to the property.
Name of the fee.
Detailed explanation of the fee.
Fee amount.
Indicates whether the fee is already included in the price.
rooms object[]
Room metadata linked to the hotel.
Room identifier unique within the hotel.
descriptions object[]
Localised room descriptions.
Description text.
ISO 639-1 language code for the description.
occupancies object
Occupancy limits for the room.
Maximum number of adults.
Maximum number of children.
Maximum total occupancy, adults plus children.
images object[]
Media assets associated with the room.
Media identifier.
Display order for the image.
Public URL for the image asset.
beds object[]
Bed configuration information.
Bed type such as KING or TWIN.
Number of beds of the specified type.
amenities object[]
Amenities available at the hotel.
Amenity code used to uniquely identify the feature.
Amenity type, for example ROOM or HOTEL.
Human readable description of the amenity.
media object[]
Media assets that describe the hotel visually.
Media identifier.
Display order to render the media.
Public URL for the media asset.
location object
Geographical information for the hotel.
Street address of the hotel.
City where the hotel is located.
Postal or ZIP code.
ISO 3166 alpha-2 country code.
State or province name.
coordinates object
Geographical coordinates.
Longitude in decimal degrees.
Latitude in decimal degrees.
closestDestination object[]
Destinations located near the hotel.
Destination code.
Destination name.
airports object[]
Airports located near the hotel.
Airport code, typically IATA.
contact object
Contact details for the property.
Primary contact email address.
Primary contact phone number.
Fax number when available.
Website URL for the hotel.
Pagination token to retrieve the next batch of hotels.
{
"auditData": {
"requestId": "string",
"transactions": [
{
"accessId": "string",
"request": "string",
"response": "string",
"id": "string",
"duration": 0,
"httpUrl": "string",
"httpStatusCode": 0,
"httpResponseHeaders": {}
}
]
},
"errors": [
{
"type": "ERR_TYPE_NONE",
"code": "ERR_CODE_NONE",
"description": "string",
"additionalData": {},
"accessId": "string"
}
],
"warnings": [
{
"code": "WARN_CODE_NONE",
"description": "string",
"additionalData": {},
"accessId": "string"
}
],
"debugData": [
{
"type": "string",
"value": "string"
}
],
"hotels": [
{
"code": "string",
"hotelName": "string",
"descriptions": [
{
"text": "string",
"languaje": "string"
}
],
"category": "string",
"propertyType": "string",
"chainCode": "string",
"boardCodes": [
"string"
],
"mandatoryFee": [
{
"name": "string",
"text": "string",
"price": 0,
"included": true
}
],
"rooms": [
{
"code": "string",
"descriptions": [
{
"text": "string",
"languaje": "string"
}
],
"occupancies": {
"adults": 0,
"childrens": 0,
"total": 0
},
"images": [
{
"code": "string",
"order": "string",
"url": "string"
}
],
"beds": [
{
"type": "string",
"count": 0
}
]
}
],
"amenities": [
{
"code": "string",
"type": "string",
"description": "string"
}
],
"media": [
{
"code": "string",
"order": "string",
"url": "string"
}
],
"location": {
"address": "string",
"city": "string",
"zipCode": "string",
"country": "string",
"state": "string",
"coordinates": {
"longitude": 0,
"latitude": 0
},
"closestDestination": [
{
"code": "string",
"name": "string"
}
],
"airports": [
{
"code": "string"
}
]
},
"contact": {
"email": "string",
"phoneNumber": "string",
"fax": "string",
"web": "string"
}
}
],
"token": "string"
}