Itinerary APIs
The Itinerary APIs are designed to streamline the hotel booking process by breaking it down into manageable steps. Once a user selects a specific hotel, these APIs enable them to view and choose rooms and rates, add and save guest details, and ultimately complete the hotel booking seamlessly.
Get Rooms & Rates
This is the initial API in the itineraries workflow, commonly referred to as the "Create Itinerary" API, as it initiates the creation of a hotel itinerary. The API organizes room and rate data into multiple recommendations, where each recommendation represents a bookable set of rates. A rate includes detailed information about the room, occupancy, room-category, meal options, pricing, cancellation policies, and much more. It’s important to proceed with a specific recommendation for booking, as only the rates and rooms from that chosen recommendation will be booked.
The Get Room Rates API provides detailed information about hotel rooms, pricing, and recommendations to help users find the best available options. Below are the key components of the API response:
Rooms – Contains details about each room, including the room name, description, available facilities, bed configuration, and room size.
Rates – Provides pricing details for each room, including the total cost, base rate, taxes, fees, refundability status, and cancellation policies.
Recommendations – Each recommendation corresponds to a specific rate within the rates array. This helps group different pricing options for the same room type (e.g., refundable and non-refundable rates). The recommendationId from this response is required for booking. A recommendation can contain different rate types. For details see the table below.
Standardized Rooms – Ensures consistency in room details by normalizing data from multiple sources.
This API allows seamless integration for retrieving structured and accurate hotel room pricing information.
Understanding different Rate Types and Price Calculation
The diagram below provides an overview of the different rate types within a recommendation and explains how to calculate the total price for a booking.
Rate Types | Structure in Recommendation | Price Calculation |
---|---|---|
Unique Rates | Rate X - Room1 Rate Y - Room2 Rate Z - Room3 | X + Y + Z |
Duplicate Rates | Rate X - Room1 Rate X - Room2 Rate X - Room3 | X + X + X |
Combo Rates | Rate X - [Room1, Room2, Room3] | X |
Hybrid Rates | Rate X - [Room1, Room2] Rate Y - Room3 OR Rate X - Room1 Rate X - Room2 Rate Y - Room3 | X + Y OR X + X + Y |
API Reference:
https://volt-docs.travclan.com/reference/post_api-v1-hotels-itineraries
Save Rooms & Rates
This API performs the second step in the itinerary flow. Once the user has finalized the rate/s and room/s he can make use of this API to save the the selections to the itinerary.
API Reference:
Get Itinerary Details
This is a helping API to get the current state of the itinerary at any point during the booking flow. You can make use of the options this API provides to query multiple piece of information such as guest validations which can be used to know what all guest information is required to book the itinerary, static content and you can also get the original search request data.
API Reference:
https://volt-docs.travclan.com/reference/get_api-v1-hotels-itineraries-itinerarycode
Save Guest Details
This API can be used to save the guest information to the itinerary. Generally speaking, you should atleast pass the details of the lead guest for every room. To know about the exact details about what guest details are required to be passed, check the guest rules/validations by making use of the Get Itinerary API.
API Reference:
Check Price
Hotel prices are dynamic and can change at any time. To prevent booking failures due to price changes, it’s essential to pass the correct price during the booking process. This API ensures that by verifying whether the itinerary price remains the same or has changed. If there’s a price change, it’s recommended to notify the user and proceed with the booking only after obtaining their consent. Attempting to book with outdated prices will result in a booking failure.
API Reference:
https://volt-docs.travclan.com/reference/get_api-v1-hotels-itineraries-itinerarycode-check-price
Updated 20 days ago