Overview

The Ratebook API helps travel companies to reduce buy rates and increase margins. By focusing on the checkout stage we are able to focus on the moment of conversion with clear buy intent, dynamically source the best buy rate for you to service the sale.

This guide will take you through the steps needed to run a POC and be well on your way to lower buy rates adn increased profits!

POC Goals

The purpose of this POC is to analyze your book requests in real time and provide you with:

• 📈 Clear business case with supporting numbers and demonstrable ROI
• 📺 Access to real-time monitoring and detailed analysis through dedicated dashboards
• 🔐 Secure and non-intrusive testing flow with a simple single data submission call

**At the end you will have a comprehensive overview of system performance and financial metrics :

Preliminary Notes

• The POC is not impacting any existing processes and/or flows you may have in place
• You will be provided with the 'Username' and 'Password' for authenticating your data submission.
• You will be provided with the 'Username' and 'Password' to monitoring and insights dashboard to review the results of the POC.

Steps for completing the POC

Step 0 - How 'does it work'?

Before proceeding with the POC, it’s good to understand how the service functions overall:

The key is understanding when to execute the data submission request call. The request should always be sent right the booking is made i.e. after the consumer has clicked book. When the request is submitted to the service, it will research and analyze the supply pool for a lower price point than the intended buy price you've submitted.

More information - How Ratebook Operates.

Step 2 - How to identify Hotels?

In order to compare the rates accurately our service would need to identify the hotel submitted in your request.

We provide a simple approach where you simply pass any Supplier ID (from Gimmonix Integrated suppliers)** along with the Supplier's Hotel ID** .

Step 3 - Data submission

The data submission process itself is as simple as 'copy-pasting' your book request related data fields:

1. The Hotel : SupplierId along with the Supplier HotelId.
2. The Room: Room name (with room ID if available) and the room's meal plan.
3. Pricing and policy: Your intended buy price, currency and refundability.
4. The rest of the request can be hard-coded (as shown in the example below) without the need to pass more information (e.g. 2 adults as default amount of travelers)

Step 4 - What information is submitted?

As the following request suggests, total of 9 parameters :

1. SupplierHotel.SupplierId - The supplierId which used to identify the hotel.
2. SupplierHotel.SupplierHotelId - The HotelId of the chosen supplier.
3. CheckIn - Check-In date in epoch format.
4. CheckOut - Check-out date in epoch format.
5. Currency - The currency of the buying price from your supplier.
6. BookingPrice - The buying price of the wanted room.
7. RefundableUntil - The date which the room is refundable until in epoch format..
8. RoomBasis - The room's Meal-Plan. (Room only, Bed and Breakfast, Half Board, Full Board or All Inclusive)
9. RoomName - The room's name.

{
	"rqst": {
		"Credentials": {
            "UserName": "smartbook_api_demo",
            "Password": "smartbookapip"
		},
		"RequestType": 21,
		"TypeOfService": 2,
		"Request": {
			"__type": "HotelSmartBookRequest",
			"ClientIP": null,
			"HotelId": null,
			"GimmonixHotelId": 0,
			"SupplierHotel": {
				"SupplierId": 1165,  // !! This parameter needs to be Filled. (1)
				"SupplierHotelId": "893195"  // !! This parameter needs to be Filled. (2)
			},
			"CheckIn": "/Date(1733561372000)/",  // !! This parameter needs to be Filled. (3)
			"CheckOut": "/Date(1733734172000)/",  // !! This parameter needs to be Filled. (4)
			"Residency": "US",
						"Price": {  // !! This parameter needs to be Filled. (5 + 6)
                "BookingPrice": 300, 
                "Currency": "USD", 
                "TotalTax": {
                    "Amount": 0, 
                    "IsIncluded": false,
                    "Currency": null 
                },
                "TotalFee": {
                    "Amount": 0, 
                    "IsIncluded": false,
                    "Currency": null 
                }
            },
			"RefundableUntil": "/Date(1733302172000)/",  // !! This parameter needs to be Filled. (7)
			"Rooms": [
				{
					"AdultsCount": 2,
					"Id": "7e6f9032-fe51-4759-b88a-22c5c75a7070",
					"RoomBasis": "Room Only RO",  // !! This parameter needs to be Filled. (8)
					"RoomName": "2 Queen Beds Room",  // !! This parameter needs to be Filled. (9)
					"KidsAges": []
				}
			],
			"WorkMode": 1,
			"LeadPaxRoomId": "7e6f9032-fe51-4759-b88a-22c5c75a7070",
			"Language": "en"
		}
	}
}

ℹ️

Do not submit any personal information - keep the passenger data as-is.

Step 5 - Review Results

During and after the POC, you will be able to access a monitoring dashboard that will provide stats on the service performance as well as the profit upside it would've been able to capture.

This will alow you to evaluate the service performance and gain insights into potential profit increase opportunities.

Support: During & After the POC

If you require any assistance, have questions or need clarification, you have two options available:

1. Search in our Documentation for the information you need. (Recommended)
2. Submit a support ticket to our dedicated support team.