Introduction

4min

Audience

This documentation is provided for customers and partners with existing API connections. We no longer offer this API for new connections.

All new connections will be made to the new API. Information about connecting to this API may be found at https://developer.aboveproperty.com.

For any questions and support for this legacy API, please contact us at [email protected].

Overview

Bonotel Exclusive Travel offers the ability for organizations to connect their client applications directly to hotel product offers and content.

This is accomplished via integration with available APIs and content sources.

  • Transactional API
    • Availabilty Search / Shopping
    • Pre-book
    • Reservation
    • Cancel
    • Lookup
    • Report
  • Content API
  • Content Files

Important Points

  • When searching for availability and rates, you can search by city, hotel, or multiple hotels. However, note that as of 2024, Bonotel strongly recommends discontinuing searches by Bonotel-defined city codes. We will be phasing out support for this by mid-2025.
  • The system will provide net rates to the customer (i.e. customer’s contracted rate with Bonotel).
  • The rates are provided as rate per room per day (room type / bed combination) and the total cost of booking each room type / bed combination. The total cost is the final amount the Tour Operator will pay Bonotel per room.
  • Taxes are included in rates, but additional fees (e.g.: Resort Fees) are displayed as either "Included" or "Excluded" in the price.
  • Wherever a special promotion applies e.g.: book 5 nights and pay for 4, the free night daily rate will return as 0.0 unless there is an inclusive resort fee on the free night, then you would see this fee.
  • It is possible to send notes/comments and your booking reference numbers when requesting a reservation. However, these notes are not always reviewed or honored by hotels. Please do not assume that your requests will be acknowledged and fulfilled. Our call center
    
    is available for direct follow up with hotels if necessary. If sending notes, please limit to standard UTF-8 characters and numbers only.
  • Cancellation policy/fee rules will be sent via the availability response message when you request them - details below. Cancel policy is based on the hotel local time zone.
  • Ages are required for children, and child cutoff age limitations will apply. If a child is over the cutoff age, the interface will count this person as an adult.
  • When bookings are saved, the system will return your confirmation number, and the status attribute would equal ‘Y’. When bookings are not saved, we will return an error code and the status attribute would equal ‘N.’
  • Customer-configured timeout values are not supported. An industry standard timeout setting for customer and supplier connections has been established at 60 seconds. If a reservation request is initiated by a customer and confirmed within 60 seconds, that reservation is considered confirmed with Bonotel and the supply partner and will be evaluated accordingly. If a customer requires a shorter timeout value for their client system, it is at their discretion to develop a solution that queries for reservations made beyond the timeout value and initiate an immediate cancellation request. Cancellation policies, including non-refundable conditions should be evaluated prior to initiating a cancellation request.
  • Static hotel content is being provided separately. It consists of hotel info, room combination info, hotel contact info, hotel accessible facilities info, city list, and more. We also offer a Data API, which is covered in a separate specifications document.
  • The customer will need to add a mark up to the rates received from the interface, collect payment, and send final confirmations to the guests.
  • Payment transactions are not conducted via this API.     

General Policies

  • The Maximum number of nights that can be searched is 30.
  • All rooms must include at least 1 adult.
  • Each room must have a valid primary guest name where first and last name are each longer than 1 character.
  • We do not recommend sending special characters in any field. Not all hotels or supplier systems support them.
  • All guests designated as children must include age. Cutoff age for children varies by hotel, but the maximum is 18. The age element should only be used for children.
  • Hotel fees and cancel policies must be requested and captured from our availability method.
  • Do not use the legacy solutions for cancellation policies in the availability response, which includes the following elements:
    • bookingPolicy and policyDescription – instead, always include cancelpolicy="Y" as an attribute of the root element for availabilityRequest and use the roomBookingPolicy sections per room that returns.