Overview

Implementing Ratebook API in the bookings flow has a few aspects that highly recommended to plan before starting the implementation:

Understanding how Ratebook operated.
Understanding the required flow adjustments on partners side.
Ratebook risk-awareness.
Prerequisites.

Ratebook API - Flows

Flow	Description	Documentation	Key Difference
Ratebook API Flow	Ratebook API Request will search, compare and books alternative hotel rooms, by finding the same type of room at a better price point in a single call.	Click here.	A single request that searches, compares, and books an alternative room at a better price point.
Ratebook - Prefetch Flow	Ratebook Prefetch API Request will search and compare alternative hotel rooms, by finding the same type of room at a better price point. Then - another Ratebook API Request, will proceed to book the room.	Click here.	The first request will only search and compare rooms for and store information. The second request will proceed to book the room. **It is best to initiate the prefetch while the end customer is filling in the booking and passenger information.

How Ratebook Operates

Here's an overview of the process:

Partner initiates a search and follows through all the necessary steps up to the point of booking the room.
Right before submitting the booking request to the supplier, the partner triggers a Ratebook API request to Gimmonix.
The Ratebook API then searches for and compares alternative hotel rooms, by finding the same type of room at a better price point.
If Ratebook finds a room offer with a better price point, it automatically books this room.
In cases where Ratebook does not find a offers at a better price point, it returns a message advising the user to continue with their original room offer.

Identifying the Hotel

The Ratebook API provides partners with three methods to identify any hotel:

Partner's HotelID:
This requires the partner to pre-map their properties. Once mapping is completed, the partner can use their own HotelID in the request to identify the hotel.

Passing Partner's HotelID as part of the Request
Gimmonix HotelID:
This allows partners to use the predefined hotel IDs in the Gimmonix system to identify the hotel in the request.

passing Gimmonix HotelID as part of the Request
Supplier HotelID + SupplierID:
This method enables hotel identification by specifying the HotelID of any supplier connected to Gimmonix, along with the corresponding SupplierID. (List of supported Suppliers along with their ID).

Passing Supplier HotelID + SupplierID as part of the Request

Required Flow adjustments

The Ratebook API seamlessly integrates into the booking process prior to sending the Book-Request to accommodation suppliers.

This integration ensures that the necessary flow adjustments occur solely at the booking step, ensuring swift and effortless integration.

Risk Awareness

Room Mapping
Ratebook API leverages a sophisticated room mapping to compare requested rooms with alternative options.
This incorporates various room attributes including room name, meal plan, room category, cancellation policies, and more.

By ensuring the booking of the precise room, it effectively minimizes risks and enhances precision in the booking process.

Interactive process
The Ratebook logic integrates an interactive process designed to seamlessly handle instances where information is not fully comprehended or alternative room options are unavailable.

In such cases, Ratebook intelligently halts the process and provides clear guidance to proceed with the original room option, guaranteeing that if no alternative room is identified, users can confidently proceed with their native room option.

Prerequisites

Before you can start leveraging the capabilities of the Ratebook API, there are several key steps you need to complete:

Property Mapping
Ratebook API requests can be initiated using either your own HotelIDs or Gimmonix HotelIDs. Mapping between each of your properties and their respective HotelIDs is imperative for seamless functionality.

The mapping process can be done simply by sharing your properties mapping file, along with your HotelIDs.

Connecting Accommodation Supplier
For Ratebook to effectively conduct searches, comparisons, and bookings, it is essential to create and configure your accommodation suppliers within Gimmonix system.

This can be done by providing API credentials to Gimmonix, enabling to create the necessary accounts and configure them accordingly.

Once the Ratebook API workflows and prerequisites are fully met and comprehended, you may proceed to the Ratebook API Documentation.