Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Impala

Impala Bookings API

Making and managing bookings.

Documentation Provider Profile APIs.io OpenAPI GitHub

Impala Bookings API is one of 3 APIs that Impala publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Bookings. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 3 paths, and defines 25 schemas. It is described by OpenAPI 3.0.0, at version 1.003.

Requests are made against 2 base URLs: https://sandbox.impala.travel/v1, https://api.impala.travel/v1.

6 operations 3 paths 25 schemas 1 DELETE2 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.003
Base URL
https://api.impala.travel/v1
Authentication
API Key, HTTP Bearer
Contact
Impala Developer Support
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Impala Bookings API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (API_Key_Authentication). It accepts HTTP bearer tokens (JWT) (paymentAuth). By default, every request must be authenticated.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Bookings 6

Making and managing bookings.

GET
/bookings
List all bookings
listBookings 7 params → 200400401500
POST
/bookings
Create a booking
createBooking body → 202400401403500
DELETE
/bookings/{bookingId}
Cancel a booking
cancelBooking 1 param → 200400401403404500
GET
/bookings/{bookingId}
Retrieve a booking
retrieveBooking 1 param → 200400401404500
PUT
/bookings/{bookingId}
Change a booking
updateBooking 1 param body → 200400401404500
PUT
/bookings/{bookingId}/booking-contact
Change a booking contact
updateBookingContact 1 param body → 200400401404500

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are booking (14 properties), hotelStub (12 properties), bookedRate (8 properties), address (7 properties). Each schema is shown below with its type and property counts.

updateBookingVersionAtTimestamp
string
The timestamp of when the booking was last updated
notesBooking
object
Notes allow sellers to their guests to communicate relevant information to the hotel.
2 properties
personInfo
object
Information on a person and their contact details.
3 properties 3 required
money
object
An amount of money in the specified currency (used in the context of prices, fees, refunds etc.)
2 properties 2 required
bookedRate
object
Information on the price of the booked room, other components of the room (such as breakfast, lunch or a welcome drink) and the cancellation policies that appl…
8 properties 7 required
bookingRequest
object
6 properties 4 required
address
object
Physical address
7 properties 5 required
rateComponent
object
Product or service offered as part of a rate in addition to accommodation in the room.
3 properties 2 required
validationError
cancellationPolicy
object
A rule that applies if the booking is cancelled.
4 properties 3 required
cancellationFee
object
Describes the costs associated with a cancellation and how it is calculated.
3 properties 2 required
hotelAgreementStub
object
Essential information on an agreement with a hotel.
7 properties 3 required
updateBookingRequest
taxOrFee
object
Details of a tax or fee (included or excluded in a rate).
3 properties
bookedRoom
object
5 properties 3 required
notesBookedRoom
object
Notes about this booked room. These might be requests for room setup (e.g. extra beds or requests to remove alcoholic beverages from the minibar) or other requ…
2 properties 2 required
pagination
object
Information that helps paginate through lists of resources.
4 properties 4 required
updateBookingContactRequest
object
Request body for update contact booking
2 properties 2 required
hotelStub
object
Essential information on a hotel returned as part of other resources, linking to the full resource within its href field.
12 properties 6 required
validationResult
object
Describes the validation that failed.
3 properties 2 required
booking
object
Details of an existing booking.
14 properties 10 required
location
object
Precise location on a map (using WGS 84 longitude and latitude notation)
2 properties 2 required
timeRange
object
A time range. Open-ended time ranges are indicated by omitting either start or end in the object.
2 properties
image
object
4 properties 3 required
genericError
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

impala-bookings-api-openapi.yml Raw ↑

Other APIs Impala publishes across the network.

Impala Hotels API
AE Profile APIs.io
Impala Rate Calendar API
AE Profile APIs.io
#Bookings
← Back to I APIs
API Details
ID
impala:impala-bookings-api
Base URL
https://api.impala.travel/v1
Docs
https://www.postman.com/getimpala/impala-hotel-booking-api/documentation/fdkbiih/impala-hotel-booking-api
Provider
Impala
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network