/bookings/{bookingId}

Retrieve a booking

• bookingId (path, required) — The unique identifier of the booking you would like to update.

/bookings

List all bookings

• start (query) — Allows for filtering based on arrival date of the booking in ISO 8601 format (e.g. `2021-12-01`). Available modifiers include less than (`lt`), greater than (`gt`), lower than or equal to (`lte`), greater than or equal to (`gte`) and equal to (`eq`). Usage example: `?start[lte]=2021-12-20&start[gte]=2021-12-10`
• end (query) — Allows for filtering based on departure date of the booking in ISO 8601 format (e.g. `2021-12-01`). Available modifiers include less than (`lt`), greater than (`gt`), lower than or equal to (`lte`), greater than or equal to (`gte`) and equal to (`eq`). Usage example: `?end[lte]=2021-12-25&end[gte]=2021-12-15`
• created (query) — Allows for filtering based on creation date and time of the booking in ISO 8601 format (e.g. `2020-11-04T17:37:37Z`) and UTC timezone. Available modifiers include less than (`lt`), greater than (`gt`), lower than or equal to (`lte`), greater than or equal to (`gte`) and equal to (`eq`). Usage example: `?created[lte]=2020-11-04T19:37:37Z&created[gte]=2020-11-04T15:56:37.000Z`
• updated (query) — Allows for filtering based on the date and time the booking was last updated, in ISO 8601 format (e.g. `2020-11-04T17:37:37Z`) and UTC timezone. Available modifiers include less than (`lt`), greater than (`gt`), lower than or equal to (`lte`), greater than or equal to (`gte`) and equal to (`eq`). Usage example: `?updated[lte]=2020-11-04T19:37:37Z&updated[gte]=2020-11-04T15:56:37.000Z`
• size (query, limit) — Pagination size. Defaults to 100 if omitted.
• offset (query, offset) — Pagination offset. Defaults to 0 if omitted.
• sortBy (query) — Order in which the results should be sorted. Currently allows you to sort by `createdAt` and `updatedAt`. Specify multiple paramaters by separating with commas

/bookings

Create a booking

/bookings/{bookingId}

Cancel a booking

• bookingId (path, required) — The unique identifier of the booking you would like to update.

/bookings/{bookingId}

Change a booking

• bookingId (path, required) — The unique identifier of the booking you would like to update.

/bookings/{bookingId}/booking-contact

Change a booking contact

• bookingId (path, required) — The unique identifier of the booking you would like to update.

/hotels

List all hotels

• name (query) — Allows for filtering based on the property name. Available modifiers include equal to (`eq`) or case insensitive search (`like`). Usage example: `?name[like]=palace`
• starRating (query) — Allows for filtering based on the starRating of a property. Available modifiers include less than (`lt`), greater than (`gt`), less than or equal to (`lte`), greater than or equal to (`gte`) and equal to (`eq`). Usage example: `?starRating[gt]=3&starRating[lt]=5`
• country (query) — Allows for filtering based on the country of a property. The only available modifier for this parameter is equal to (`eq`). Usage example: `?country[eq]=GBR`
• start (query) — The arrival day of the desired stay range in ISO 8601 format (`YYYY-MM-DD`).
• end (query) — The departure day of the desired stay range in ISO 8601 format (`YYYY-MM-DD`).
• latitude (query) — The WGS 84 latitude of the location to search around (e.g. `58.386186`).
• longitude (query) — The WGS 84 longitude of the location to search around (e.g. `-9.952549`).
• radius (query) — The distance (in meters) to search around the specified location (e.g. `10000` for 10 km).
• hotelIds (query) — A comma-separated list of hotel ids you wish to filter by (e.g. `60a06628-2c71-44bf-9685-efbd2df4179e,60a06628-2c71-44bf-9685-efbd2df4179e`).
• created (query) — Allows for filtering based on the date and time when this hotel was first added to the Impala platform, in ISO 8601 format (e.g. `2020-11-04T17:37:37Z`) and UTC timezone. Available modifiers include less than (`lt`), greater than (`gt`), lower than or equal to (`lte`), greater than or equal to (`gte`) and equal to (`eq`). Usage example: `?created[lte]=2020-11-04T19:37:37Z&created[gte]=2020-11-04T15:56:37.000Z`
• updated (query) — Allows for filtering based on the date and time the content of this hotel was last updated, in ISO 8601 format (e.g. `2020-11-04T17:37:37Z`) and UTC timezone. Available modifiers include less than (`lt`), greater than (`gt`), lower than or equal to (`lte`), greater than or equal to (`gte`) and equal to (`eq`). Usage example: `?updated[lte]=2020-11-04T19:37:37Z&updated[gte]=2020-11-04T15:56:37.000Z`
• size (query, limit) — Number of hotels returned on a given page (pagination).
• offset (query, offset) — Offset from the first hotel in the result (for pagination).
• sortBy (query) — Order in which the results should be sorted. Currently allows you to sort by `name` (alphabetical), star `rating`, and `distance_m` in meters from the specified latitude/longitude. Allows for a comma-separated list of of arguments with modifiers for `:asc` (ascending) and `:desc` (descending) ordering.

/hotels/{hotelId}

Retrieve a hotel

• hotelId (path, required) — The unique identifier of this hotel on the Impala platform.
• start (query) — The arrival day of the desired stay range in ISO 8601 format (`YYYY-MM-DD`).
• end (query) — The departure day of the desired stay range in ISO 8601 format (`YYYY-MM-DD`).

/hotels/{hotelId}/rate-plans

List all rate plans (rate calendar) for a hotel (Beta endpoint)

/hotels/{hotelId}/rate-plans/{ratePlanId}

List a rate plan (rate calendar) for a hotel (Beta endpoint).