Ratebook API - Prefetch Flow

Overview - Prefetch Flow

The Ratebook Prefetch Flow enables partners to shorten booking timeout periods by dividing the Ratebook flow into two distinct calls, as explained in the Implementation Guide. The Ratebook request involves two requests: Search and Book.

Using the Prefetch Flow, partners can send a 'Prefetch request' to search for hotel and room options, identifying alternatives while the customer completes their booking information.

When the book request for the Ratebook is initiated, the results are already processed, allowing the room to be booked more quickly.

Ratebook API

The Ratebook Prefetch Request expects the following data:

  • Credentials - username and password as granted from Gimmonix.
  • Hotel and Room information-
    • Either - Partner's HotelID or Gimmonix HotelID or Supplier HotelID + SupplierID.
    • Check-in and Check-out dates.
    • Booking price (Net price) and Currency.
    • Costumes residency.
    • Refundability.
    • Room information (Room name, Meal Plan, number of Adults + Kids, room category etc).

The Ratebook Request expects the following data:

  • Credentials - username and password as granted from Gimmonix. (Similar to the Prefetch Request)
  • Hotel and Room information- (Similar to the Prefetch Request)
    • Either - Partner's HotelID or Gimmonix HotelID or Supplier HotelID + SupplierID.
    • Check-in and Check-out dates.
    • Booking price (Net price) and Currency.
    • Costumes residency.
    • Refundability.
    • Room information (Room name, Meal Plan, number of Adults + Kids, room category etc).
  • Passengers - Passenger information and room allocations.

๐Ÿšง

Special Parameters :

  • Room Id:
    Under the "Rooms" field, each "Id" - should be a unique (per reach room), self-generated GUID.
  • Passenger Id:
    Under the "LeadPassenger" and "AdditionalPassengers" fields - each passenger "Id" should be unique (per reach passenger), self-generated GUID.
  • Allocation:
    Under the "LeadPassenger" and "AdditionalPassengers" fields - each passenger's "Allocation" should be the respective room "Id" which was generated in the "Rooms" field.

Ratebook API Flow - Postman API Examples

RequestDescriptionPostman API Example
Ratebook Prefetch RequestPrefetch request searches for the hotel and rooms options and find alternatives while the end customer fills out the booking information.Click here.
Ratebook RequestRatebook Request initiates the actual book request to the alternative room option.Click here.

๐Ÿ‘

NOTE :

The Prefetch Request will store room information for 5 minutes, unless overridden in the API controls.

Please note that for the Ratebook API request to recognize the prefetch results, the information must be identical to the previous prefetch request (including Room Name, Basis, Cancellation Policy, Check-in/out dates, number of Adults and Kids, Booking price, Hotel, etc.)

Post Booking

After completing a Ratebook API operation and successfully booking a room, partners have the option to utilize additional post-booking requests.

Cancel a Segment

This function submits a request to cancel an existing SegmentID with Status 'OK'.

๐Ÿšง

Multi-Room Reservations

  • There are suppliers that return a single booking confirmation id for all rooms together - on HSP all rooms will be under single Segment ID.
  • There are suppliers that return for each room a unique booking confirmation id - on HSP each room will have his own Segment ID (correlated with supplier).

'Cancel Book' request supports single Segment ID only.

For case (1): all rooms will be cancelled at once.
For case (2): requires to send a 'Cancel Book' request per each SegmentID.
Or cancel part of the rooms by relevant SegmentIDs.

Cancel Segment examples (Postman) - Click here.


Check Status

This function submits a request to retrieve the updated status and booking data.

Check Status examples (Postman) - Click here.