Sign in

v1

latestOpenAPI 3.0.02026-07-141046209.2 KB
Hotels

Retrieve a hotel

Returns the full content, room types and rates for the specified hotel.

When querying the hotels API you can query with or without dates. Where querying with dates requires providing valid values for the start and end parameters. Requests without these values will be considered a query without dates.

Querying without dates:

When you query without dates, the search result will include all properties that match your request. Including all content that is associated with those properties. However you will find that the rates attribute for each room will always be empty.

Querying with dates:

When you query with dates, the search result will include all properties that match your request, including all content that is associated with those properties. Rooms which do not have available prices for the provided dates will appear with an empty rates array.

For rooms where there are available prices the rates array will include both the public rates of the hotel, along with prices that come from deals in which you are participating. This would include private deals which you have negotiated with a hotel, along with Impala deals which you have been verified for.

Using the rateId of any of those rates, you can use the Create a booking endpoint to make a booking.

get/hotels/{hotelId}

Path parameters

hotelIdstring uuid required

The unique identifier of this hotel on the Impala platform.

Query parameters

startstring
Example:2021-05-20

The arrival day of the desired stay range in ISO 8601 format (YYYY-MM-DD).

endstring
Example:2021-05-22

The departure day of the desired stay range in ISO 8601 format (YYYY-MM-DD).

Response

Returns the requested hotel.

contractableboolean required

This determines if you can negotiate directly with the hotel.

createdAtstring date-time

Date and time (in UTC and ISO 8601 format) when the hotel's stable content (i.e. all the details of the hotel excluding its rates) was created.

currencystring required

The standard currency code used by the hotel.

emailsstring[] required
hotelIdstring uuid required

Unique identifier for this hotel within the Impala platform.

namestring required

Name of the hotel.

phoneNumbersstring[] required

The hotel's phone number(s)

roomCountnumber required

The number of rooms at the hotel.

starRatingnumber double nullable required

The star rating (or star-equivalent rating)

termsAndConditionsstring required

Rules and terms that apply to this hotel and have to be shown to your guest before the make their booking.

timezonestring

The timezone the hotel is in - e.g AST

updatedAtstring date-time

Date and time (in UTC and ISO 8601 format) when the hotel's stable content (i.e. all the details of the hotel excluding its rates) was last updated.

websiteUrlstring nullable required

The URL to the hotel's website.