{ "opencollection": "1.0.0", "info": { "name": "Impala Hotel Booking Bookings Hotels API", "version": "3.0" }, "request": { "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "items": [ { "info": { "name": "Hotels", "type": "folder" }, "items": [ { "info": { "name": "List all hotels", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.impala.travel/v1/hotels", "params": [ { "name": "name", "value": "[object Object]", "type": "query", "description": "Allows for filtering based on the property name. Available modifiers include equal to (`eq`) or case insensitive search (`like`). Usage example: `?name[like]=palace`" }, { "name": "starRating", "value": "[object Object]", "type": "query", "description": "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`" }, { "name": "country", "value": "[object Object]", "type": "query", "description": "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`" }, { "name": "start", "value": "", "type": "query", "description": "The arrival day of the desired stay range in ISO 8601 format (`YYYY-MM-DD`)." }, { "name": "end", "value": "", "type": "query", "description": "The departure day of the desired stay range in ISO 8601 format (`YYYY-MM-DD`)." }, { "name": "latitude", "value": "", "type": "query", "description": "The WGS 84 latitude of the location to search around (e.g. `58.386186`)." }, { "name": "longitude", "value": "", "type": "query", "description": "The WGS 84 longitude of the location to search around (e.g. `-9.952549`)." }, { "name": "radius", "value": "", "type": "query", "description": "The distance (in meters) to search around the specified location (e.g. `10000` for 10 km)." }, { "name": "hotelIds", "value": "", "type": "query", "description": "A comma-separated list of hotel ids you wish to filter by (e.g. `60a06628-2c71-44bf-9685-efbd2df4179e,60a06628-2c71-44bf-9685-efbd2df4179e`)." }, { "name": "created", "value": "[object Object]", "type": "query", "description": "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`" }, { "name": "updated", "value": "[object Object]", "type": "query", "description": "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`" }, { "name": "size", "value": "", "type": "query", "description": "Number of hotels returned on a given page (pagination)." }, { "name": "offset", "value": "", "type": "query", "description": "Offset from the first hotel in the result (for pagination)." }, { "name": "sortBy", "value": "", "type": "query", "description": "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." } ] }, "docs": "Returns a list of all hotels worldwide that can be booked through Impala.\n\nYou can **filter** the results:\n\n* Adding `longitude`, `latitude` and a `radius` (in meters) query parameters will filter the results to hotels around this location.\n* Adding `start` and `end` dates (in ISO 8601 notation, e.g. `2021-12-31`) for the expected arrival and departure dates of your guests will limit the results to hotels that have at least one room bookable for this timeframe.\n* Adding `starRating`, `name` or `" }, { "info": { "name": "Retrieve a hotel", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.impala.travel/v1/hotels/:hotelId", "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "The unique identifier of this hotel on the Impala platform." }, { "name": "start", "value": "", "type": "query", "description": "The arrival day of the desired stay range in ISO 8601 format (`YYYY-MM-DD`)." }, { "name": "end", "value": "", "type": "query", "description": "The departure day of the desired stay range in ISO 8601 format (`YYYY-MM-DD`)." } ] }, "docs": "Returns the full content, room types and rates for the specified hotel.\n\nWhen 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.\n\n**Querying without dates:**\n\nWhen you query without dates, the search result will include all properties that match your request. Including all content that is associated with those properties" } ] } ], "bundled": true }