v1

latestSwagger 2.02026-07-14214688.6 KB
Rooms

Request available rooms using a given criteria.

get/api/hotel/v0/hotels/{hotelId}/rooms/available

Path parameters

hotelIdinteger required

The hotel you are looking for available rooms.

Query parameters

fromstring date-time required

Rooms returned will not be assigned to a reservation or be under maintenance between this date and the specified to date. Still there could be departing reservations or ending maintenances for this date.

tostring date-time required

Rooms returned will not be assigned to a reservation or be under maintenance between the specified from date and this date. Still there could be arriving reservations or beginning maintenances for this date.

adultsstring byte

Specifies number of adults the returned rooms will have to be able to house. The default value is 1.

includeOutOfServiceboolean

Should rooms that are set OutOfService in the defined time period be returned as available. By default they are not.

roomTypesstring[]

Return result only for rooms for the given room types. Allows to pass a comma-separated list of room types.

amenitiesstring[]

Return result only for rooms having all of the given amenities. You can provide a comma seperated list of amenity codes.

viewsstring[]

Return result only for rooms having at least one of the specified views. You can provide a comma seperated list of view codes.

locationsstring[]

Return result only for rooms having at least one of the specified locations. You can provide a comma seperated list of location codes.

skipinteger

Amount of items to skip.

topinteger

Amount of items to select.

inlinecount'None' | 'AllPages'

Return total number of items for a given filter criteria.

Headers

App-Idstring required

Application identifier

App-Keystring required

Application key.

Response

A list of available rooms in the specified time period.

_countinteger

The number of items matching your request in total for all pages.

_linksobject

Collection of links to related resources