Quick Start

The Booking API is documented in a machine-readable manner via a swagger.json file. Depending on your implementation language, you'll be able to code-generate an SDK to ease implementation. To learn more about the available parameters and endpoints, see the Booking API Reference.

Booking API

Meta

Represented in JSON as the meta field, this object is included in all request/response bodies and includes a Request ID (reqId) to allow for cross-system request tracing.

Channel API Implementation Tasks

The Booking API allows you to choose the suppliers with whom you want to integrate.

Query Available Suppliers

Suppliers are the providers of Products within the Booking API. To view a list of available suppliers, send a GET request to /suppliers. The response includes information such as supplier name, location, hours of operation, and accepted traveler types.

Note: The supplier_id in the response is required in order to view a supplier's products.

Query Supplier Products

A supplier can offer one or more products within the Booking API. To view a supplier's products, send a GET request to /suppliers/{supplier_id}/products. The response includes information such as product description, location, and available dates/times.

Query a Single Product

To view information on a single product, send a GET request to /suppliers/{supplier_id}/products/{product_id}. The product_id must be included in the request.

Query Product Availability

The Booking API provides real-time product availability checks. To check the availability of a product, send a GET request to /suppliers/{supplier_id}/products/{product_id}/availabilities. The response includes the remaining capacity and availability start/end times for each product.

Note: The following parameters must be specified when checking the availability of a product:

Create a Booking

To create a booking, send a POST request to /bookings.

Notes:

• Use the hold_id field to associate the booking with an existing hold.
• The booking_id in the response is required in order to retrieve or cancel it.