Travelomatix Hotel Api Documentation Final

Technical Guide
Version 3.0
Presented By: Accentria Solutions.
This document is a preliminary release and may be changed prior to final commercial release. This
document is provided for information purposes only and Accentria Solutions Pvt Ltd makes no
warranties, either express or implied, in this document.
The information contained in this document represents the current view of Accentria Solutions Pvt Ltd
on the issues discussed as of the date of publication. Information in this document, including URL and
other Internet Web site references, is subject to change without notice.
Document Guidelines Index

1) FEATURES ……………………………………………………………………………………………………… 3
2) PATHWAY ……………………………………………………………………………………………………… 3
3) C0MPRESSION …………………………………………………………………………………………………5
4) HEADER …………………………………………………………………………………………………………5
5) SEARCH ……………………………………………………………………………………………………… 5
.1 Hotel Search Request ………………………………………………………………………………….. 6
.2 Hotel Search Response ……………………………………………………………………………….. 8
6) HOTELINFO……………………………………………………………………………………………………… 10
.1 Hotel Info Response………………………………………………………………………………….. 14
7) GETHOTELROOM……………………………………………………………………………………………… 17
.1 Hotel Room request……………………………………………………………………………………. 17
.2 GetHotelRoom Response……………………………………………………………………………… 23
8) BOOKING…………………………………………………………………………………………………………. 26
8) 8. 1 BLOCKROOM……………………………………………………………………………………. 26
8) 1.1 Block room request…………………………………………………………………………………. 27
8) 1.2 BlockRoom Response……………………………………………………………………………… 27
8) .2 BOOK…………………………………………………………………………………………………….. 34
8) 2.1 BOOK REQUEST…………………………………………………………………………………….. 35
8) 2.2 Book Response in Case of Successful Booking …………………………………………… 36
1
9) HotelBookingDetail……………………………………………………………………………………….….. 38
9).2 GetBookingdetails Response: ………………………………………………………………… 39
10) CANCEL BOOKING……………………………………………………………………………………….. 39
10)1 Cancel request …………………………………………………………………………………… 39
10)2 Cancel Response………………………………………………………………………………… 40
11) GETCANCELLATIONREFUNDDETAILS………………………………………………………………… 41
11).1 CANCELLATIONREFUND REQUEST: …………………………………………………… 41
11). 2 CANCELLATIONREFUND RESPONSE: ………………………………………………………… 42
DOCUMENT CONTROL
Document Control
DOCUMENT CONTROL
Version Issue Date Description
3.0 10/06/2018 New documentation file
This document describes Travelomatix Hotel API which can be integrated into various applications (Web
app, Mobile app etc).
It is intended specially for developers and other team members to help them know how the Hotel
API Service works. This guide provides all the required information to integrate this Travelomatix
API.
All the steps right from search, to getting the room prices and policies along with the hotel details,
to price verification before booking & then final booking are sequentially followed by using a
shared transaction identifier (Resulttoken).
We strongly recommended that you read the complete guide before integration. This is RESTful
service which communicates only in JSON Format. You may use online tools like
“http://jsonlint.com/” or “http://jsonviewer.stack.hu/” (or other some similar tools) to validate
the JSON Format.
This guide explains the use of each method, what support we are providing to use the API
efficiently, how to access the resources provided by Accentria Solutions Pvt Ltd, etc. This
document also contains the certification process you need to go through for Go Live access. The
document assumes that you are familiar with web services technology. Still if you face any issue
or any concern you can reach us on:
2
Email: support@travelomatix.com
Phone: +91 8066210050
1. FEATURES
New features added in Travelomatix Hotel API
This is RESTFUL service which communicates only in JSON Format.
Light search with improved response time, and response content GZIP enabled
Schema optimization for all the methods to reduce request/response size
Cancellation policies available in free text/ Json nodes Format (whichever available)
New method to verify hold booking request
2. PATHWAY
The Travelomatix Hotel API offers the following pathway to create a booking as per the
provided criteria.
 Gets all the available Hotels for the requested

HOTEL search criteria in the specified city
SEARCH  Gets Availability of preferred hotel
 Gets Availability based on star rating of hotels
 Gets all hotel details like description,

HOTEL INFO attractions, amenities,Facilities etc for
the selected hotel
 Gets all the available hotel images
 Gets all the available rooms with their prices and

inclusions
GET HOTEL  Gets Cancellation policies and Norms
ROOM  Gets supplements (if any)
3
BLOCK  Gets the updated price of the selected rooms before
ROOM making a booking
 Gets the updated cancellation policies of the selected
rooms before making a booking
 Gets hotel booking done for selected

rooms and requested guest information
BOOK  Price verification is done before creating a
booking and Confirmation No./ Booking
Reference No. is returned in case of successful
booking
 Gets the booking information based on the Confirmation

HOTEL No. / booking reference No.
BOOKING  Also gets the updated status for Bookings with Pending
DETAILS Status
HOTEL  Used to cancel a reservation
CANCEL
4
3. COMPRESSION
For some destinations, you may get around 800 to 1200 results. Transmission of such big responses takes extra
time over the internet. To overcome this problem and reduce transmission/ response time by about 80 %, system
is enabled with gzip compression. Please check the below steps on how to receive compressed response.
Please check the below steps on how to receive compressed response.
Step 1: Request must contain the header as "Accept-Encoding:gzip, deflate".
Step 2: If server detects, the response will be compressed.
Step 3: Client receives response with the header "Content-Encoding: gzip".
Step 4: Client needs to decompress the Response before processing.
4. HEADER
x-Username -- test or production Username (travelomatix will be provide)

x-DomainKey -- test or production DomainKey (travelomatix will be provide)
x-system -- test or live system (travelomatix will be provide)
x-Password -- test or production Password (travelomatix will be provide)
5. SEARCH
This section covers the methods involved in knowing basic availability of Hotels in a city, Hotel details,
Availability of rooms and Cancellation policies to avoid any penalty. HOTELSEARCH This method is used to
search hotels available for booking in a specific city within a date range. This method checks:
Note: General availability of hotels in a specific city.
1. 'RoomGuest' will repeat for multiple rooms search.
2. Child age(s) are compulsory when search request includes child.
3. Hotel price might vary for same Search Request with different GuestNationality.
Service URL (REST) to be used: TEST

http://test.services.travelomatix.com/webservices/index.php/hotel_v3/service/Search
Service URL (REST) to be used: LIVE
http://prod.services.travelomatix.com/webservices/index.php/hotel_v3/service/Search
Sample Search Request
1 Room with 2 adults

Request
{
5
"CheckInDate": "27-06-2018",
"NoOfNights": 1,
"CountryCode": "IN",
"CityId": 6743,
"GuestNationality": "IN",
"NoOfRooms": 1,
"RoomGuests": [
{
"NoOfAdults": 2,
"NoOfChild": 0
}
],
}
2 Room with 3 adults 2 Childs
{
"CheckInDate": "27-06-2018",
"NoOfNights": 1,
"CountryCode": "IN",
"CityId": 6743,
"GuestNationality": "IN",
"NoOfRooms": 2,
"RoomGuests": [
{
"NoOfAdults": 1,
"NoOfChild": 2,
"ChildAge": [
"4",
"6"
]
},
{
"NoOfAdults": 1,
"NoOfChild": 0
}
],
5.1 HotelSearch Request
Level Element Format Comments Mandatory/ Optional

1 CheckInDate Date Start Date of the Mandatory :
requested Stay (dd:mm:yyyy)
2 NoOfNights Integer Mandatory
Nights of Stay (Minimum value should be 1)
3 CountryCode String ISO Country Code of
Destination (Ex. India
= IN, Great Britain Mandatory
4 CityId Integer Destination City Id Mandatory
5 GuestNationality String ISO Country Code (Ex. Mandatory
India = IN, Great
Britain = GB)
6
6 NoOfRooms Integer Requested number of Mandatory
rooms
7 RoomGuests [ ] Array Requested number of Mandatory
rooms
7.1 NoOfAdults Integer Number of adults in Mandatory
the room
7.2 NoOfChild Integer Number of children Mandatory
in the room (Minimum value should be 0)
7.3 ChildAge [ ] Integer Array Mandatory (Only when
Child age childcount is more than ‘0’
Sample Search Responce
{
"Status": 1,
"Message": "",
"Search": {
"HotelSearchResult": {
"HotelResults": [
{
"ResultIndex": 21,
"HotelCode": "H!0534131",
"HotelName": "Nile Residency",
"HotelCategory": "",
"StarRating": 3,
"HotelDescription": "",
"HotelPolicy": "No Hotel Policy Found",
“HotelPromotionContent”:” "Early Booking Saver. Rate includes 30% discount!”,
“HotelPromotion”:30
"Price": {
"PublishedPrice": 1238.1,
"PublishedPriceRoundedOff": 1239,
"OfferedPrice": 1238.1,
"OfferedPriceRoundedOff": 1239,
"RoomPrice": 1239,
"Tax": 0,
"ExtraGuestCharge": 0,
"ChildCharge": 0,
"OtherCharges": 0,
"Discount": 0,
"AgentCommission": 0,
"AgentMarkUp": 0,
"ServiceTax": 0,
"TDS": 0,
"RoomPriceWoGST": 1239,
"GSTPrice": 0,
"CurrencyCode": "INR"
},
"HotelPicture":
"http:\/\/demo.travelomatix.com\/demo_alpha\/new\/cdn\/1\/images\/H05341311514872453360cc27e586a4dc
e887eedf8168928f5ddc5602b.jpg",
"ImageOrder": 1,
"HotelAddress": "No.61, 4th main 1st CrossBehind, Ayyappa Temple Madiwala, Bengaluru 560068",
"HotelContactNo": "",
"HotelMap": "",
"Latitude": 12.92400737,
"Longitude": 77.61798203,
"HotelLocation": "Bangalore",
"SupplierPrice": "",
"RoomDetails": [
],
"ResultToken": "aaf9b468415ad7237d7df7398dde3342*_*1*_*Z7xwAEwGkj7cEnTc",
"HotelAmenities": [
"Fireplace in lobby ",
7
" Free wired Internet ",
" Ceiling fan ",
" Minimum check-in age is 18",
" Laundry facilities "
],
"Free_cancel_date": "",
"trip_adv_url": "",
"trip_rating": "",
"trip_reviews": "",
"trip_review_url": "",
"web_reviews_url": ""
},
"CityId": "6743"
}
}
}
5.2 Hotel Search Response

1 CityId Integer Destination City Id Mandatory
2 HotelResults [ ] Mandatory
(Can be blank in case no
Array of Array of the unique hotels found for requested
element hotel results City)
2.1 ResultIndex Mandatory
Integer Result Index
2.2 HotelCode String Mandatory
(HotelCode to be echoed
Unique hotel code back in further requests)
2.3 HotelName String Unique hotel name Mandatory
2.4 HotelCategory String Hotel Category Optional

2.5 StarRating Integer Star Rating of the hotel Mandatory
- StarRating
All = 0,
OneStar = 1,
TwoStar = 2,
ThreeStar = 3,
FourStar = 4,
FiveStar = 5
2.6 String Description of the hotel Mandatory
Promotion details of the
HotelPromotionContent hotel
2.7 String % of the Promotion Optional
HotelPromotion hotel
2.8 HotelPolicy String Hotel policy details Optional
2.9 HotelPicture String Hotel Image URL Mandatory
2.10 HotelAddress Address of Address of the hotel Mandatory
the hotel
2.11 HotelContactNo Integer Contact Number of the Optional
hotel
2.12 HotelMap String Direction Map of the Optional
hotel
2.13 Latitude String Latitude inFormation of Optional
the hotel
8
2.14 Longitude String Longitude inFormation Optional
of
the hotel
2.15 HotelLocation String Hotel Location Optional
2.16 Price [ ] Array Price Array Mandatory
(Minimum price of the
hotel rooms)
2.16.1 RoomPrice Decimal Price of the room Mandatory
2.16.2 Tax Decimal Optional
Tax applicable for the
room
2.16.3 ExtraGuestCharge Decimal Extra Guest Charges Optional
applicable for the room
2.16.4 ChildCharge Decimal Child Charges applicable Optional
for the room
2.16.5 OtherCharges Decimal Other Charges Optional
applicable
for the room
2.16.6 Discount Decimal Discount applicable for Optional
the room (Currently not in use)
2.16.7 PublishedPrice Decimal Mandatory
Published Price of the (This price would be
room different only if Room
Price is on PUBLISHED.
In case of NET, Published
Price would be same as
Offered Price)
2.16.8 Integer Published Price Mandatory
PublishedPriceRounde (rounded (This price is for display
dOff off) of the room purpose only)
2.16.9 Decimal Offered Price of the Mandatory
OfferedPrice room
2.16.10 Integer Offered Price (rounded Mandatory
off) of the room (This price is for display
OfferedPriceRoundedO ff purpose only)
2.16.11 Decimal Commission applicable Optional
on the Room Price (TBO will part this amount
if Room Price is on
AgentCommission Published)
2.16.12 Decimal Optional
Agent Mark Up (Agent will earn this
applicable amount if Hotel markup is
AgentMarkUp on the Room Price set from backend)
2.16.3 Decimal Optional
Agent Mark Up
applicable
ServiceTax on the Room Price
2.16.4 TDS Decimal TDS applicable on Optional
2.16.5 String Price currency(Mandatory)
CurrencyCode Price currency
2.17 decimal Trip Advisor Rating Optional
(This would come only
when trip advisor rating is
available for the particular
trip_rating hotel)
2.18 trip_adv_url String Trip Advisor image URL Optional
9
when trip advisor rating/
url is available for the
particular hotel)
2.19 Trip Advisor Reviews Optional
count (This would come only
when trip advisor trip reviews
count is available for the
trip_reviews Integer particular hotel)
2.20 Trip Advisor Review Url Optional
when trip advisor trip reviews
url is available for the
trip_review_url String particular hotel)
2.21 Trip Advisor hotel Optional
Review url (This would come only
when trip advisor hotel reviews
is available for the
web_reviews_url String particular hotel)
2.22 datetime API last cancellation
date Mandatory
Free_cancel_date API last cancellation date
6. HOTELINFO
This method is used to request for hotel descriptive content information based on ‘ResultToken’,
HotelDetailsResponse consist of the Hotel images, facilities, attractions, amenities and other basic details of the
hotel.

http://test.services.travelomatix.com/webservices/index.php/hotel_v3/service/HotelDetails

http://prod.services.travelomatix.com/webservices/index.php/hotel_v3/service/HotelDetails
Sample Request:
{
"ResultToken": "eddd9094df28bee5e2004e935d810992*_*1*_*wEt3Sk7WzRqH7I1h"
}
6.1 Hotelinfo Request
Level Element Format Comments Mandatory/Optional

1 Result Token String Result Token Mandatory
(ResultToken to be
called back
from search
response. This
can be used to trace
10
particular search/
book at
Travelomatix's end)
Sample Response:
{
"Status": 1,
"Message": "",
"HotelDetails": {
"HotelInfoResult": {
"HotelDetails": {
"checkin": "2018-06-27",
"checkout": "2018-06-28",
"HotelName": "Ekaa",
"HotelCode": "H!0393714",
"StarRating": 4,
"Description": " Property Location<\/b> Located in Begur, Hotel Ekaa is in the entertainment district and
convenient to The Oxford College and Laser Republic. This 4-star hotel is within close proximity of Columbia Asia
Hospital and St. John's Auditorium.<\/p> Rooms<\/b> Make yourself at home in one of the 32 air-conditioned
rooms featuring fireplaces and LCD televisions. Complimentary wireless Internet access keeps you connected, and
cable programming is available for your entertainment. Private bathrooms have deep soaking bathtubs and
complimentary toiletries. Conveniences include phones, as well as safes and desks.<\/p> Amenities<\/b> Take
advantage of recreation opportunities including a nightclub and a fitness center. Additional amenities at this
Victorian hotel include complimentary wireless Internet access, concierge services, and a television in a common
area. Guests can catch a ride to nearby destinations on the area shuttle (surcharge).<\/p> Dining<\/b> Enjoy
Indian cuisine at Melange, one of the hotel's 2 restaurants, or stay in and take advantage of the 24-hour room
service. Snacks are also available at the coffee shop\/cafe. Mingle with other guests at the complimentary
reception, held daily. Quench your thirst with your favorite drink at the bar\/lounge. A complimentary hot\/cold
buffet breakfast is served daily from 6 AM to 10:30 AM.<\/p> Business, Other Amenities<\/b> Featured amenities
include complimentary wired Internet access, a business center, and express check-in. Planning an event in Begur?
This hotel has 3000 square feet (270 square meters) of space consisting of a conference center and a meeting
room. A roundtrip airport shuttle is provided for a surcharge (available 24 hours), and free valet parking is available
onsite.<\/p>",
"Attractions": [
],
"HotelPolicy": "No Hotel Policy Found",
"HotelFacilities": [
"Fitness facilities ",
" Concierge services ",
" Total number of rooms - 32",
" Number of floors - 3",
" Phone ",
" Free toiletries ",
" Iron\/ironing board ",
" Diners Club ",
" MasterCard ",
" Free breakfast ",
" Room service (24 hours) ",
" Desk ",
11
" Business center ",
" Express check-out ",
" Premium TV channels ",
" Designated smoking areas ",
" Free WiFi ",
" Free wired Internet ",
" Minimum check-in age is 16",
" Conference space size (meters) - 270",
" Free reception ",
" RV, bus, truck parking ",
" No pets or service animals allowed ",
" One meeting room ",
" Luggage storage ",
" Air conditioning ",
" Bar\/lounge ",
" Free newspaper ",
" In-room safe ",
" Laundry facilities ",
" Safe-deposit box at front desk ",
" Premium bedding ",
" Pay movies ",
" Multilingual staff ",
" Pets not allowed ",
" Free bottled water ",
" Blackout drapes\/curtains ",
" LCD TV ",
" Check-in time ends at noon",
" Free self parking ",
" Free valet parking ",
" Free parking nearby ",
" Rollaway\/extra beds (surcharge) ",
" Conference space ",
" Refrigerator ",
" Minibar ",
" Coffee\/tea maker ",
" Daily housekeeping ",
" Fireplace ",
" Discover ",
" JCB International ",
" Ceiling fan ",
" Coffee shop or cafe ",
" Check-in time starts at noon",
" Check-out time is noon",
" Dry cleaning\/laundry service ",
" Free WiFi ",
" Accessible bathroom ",
" In-room accessibility ",
" Number of restaurants - 2",
" Conference space size (feet) - 3000",
" Conference center ",
" Elevator\/lift ",
" Number of buildings\/towers - 1",
" Airport transportation (surcharge) ",
" Private bathroom ",
" Visa ",
" Coffee\/tea in common areas ",
12
" Television in common areas ",
" Nightclub ",
" In-room climate control (air conditioning) ",
" Free newspapers in lobby ",
" Spa treatment room(s) ",
" Microwave (on request) ",
" Express check-in ",
" Hair dryer (on request) ",
" Cable TV service ",
" Year Built 2012",
" Area shuttle (surcharge) ",
" Deep soaking bathtub"
],
"Address": "52 Hosur Main Road, Kudlu Gate, Behind Kudlu Gate Bus Stand, Krishna Reddy Industrial Area,
Hosapalaya, Muneshwara Nagar, Bangalore 560068, Karnataka",
"Latitude": 12.889924596,
"Longitude": 77.6394521779,
"Images": [
"https:\/\/cdn.grnconnect.com\/hotels\/images\/a6\/ad\/a6ad384d009a8a2e6aa8f0d405510690e878e89d.jpg"
],
"first_room_details": {
"Price": {
"RoomPrice": 1431,
"Tax": 0,
"ChildCharge": 0,
"OtherCharges": 0,
"Discount": 0,
"AgentMarkUp": 0,
"ServiceTax": 0,
"TDS": 0,
"RoomPriceWoGST": 1430.1,
"GSTPrice": 0,
},
"cancellation_policy": [
{
"Charge": 0,
"ChargeType": 1,
"Currency": "INR",
"FromDate": "2018-06-10 11:45:08",
"ToDate": "2018-06-21 23:59:59"
},
{
"Charge": 1430,
"ChargeType": 1,
"Currency": "INR",
"FromDate": "2018-06-22 00:00:00",
"ToDate": "2018-06-23 00:00:00"
},
13
{
"Charge": 1430,
"ChargeType": 1,
"Currency": "INR",
"FromDate": "2018-06-23 00:00:00",
"ToDate": "2018-06-27 00:00:00"
}
],
"room_name": "1 X Executive",
"Room_data": {
"RoomUniqueId": "de4afebfa30980bee3645289d7195100*_*381*_*KY7YAnnR3SkglOeo",
"rate_key": "4pefzkr64arcpw2svsjxsfgv5lmk7x5i6o76pu3z3fcan7pl",
"group_code": "wcmqxydh5arcvxksvwpgi"
}
},
"first_rm_cancel_date": "2018-06-21 23:59:59",
"cancel_date": "2018-06-23 23:59:59",
"Amenities": [
"Breakfast"
],
"trip_adv_url": "",
"trip_rating": ""
}
}
}
}
6.3 Hotelinfo Response

1 Array [] Hotel Mandatory
Information list
HotelInfoResult array
1.1 HotelDetails Array[] Hotel Details Mandatory
array
1.2 HotelCode String Unique hotel Mandatory
code
1.3 HotelName String Unique hotel Mandatory
name
1.4 StarRating Integer Star Rating of the Mandatory
hotel - StarRating
All = 0,
OneStar = 1,
TwoStar = 2,
ThreeStar = 3,
FourStar = 4,
FiveStar = 5
1.5 Description String Description of Mandatory
the hotel
1.6 Attractions Array[] Array of the Optional
attractions
associated with
the hotel
1.7 HotelFacilities Array[] List of hotel Mandatory
facilities
14
1.8 HotelPolicy String Hotel policy Optional
details
1.9 Images Array List Url of images of Mandatory
the
1.10 Address String Address of the Optional
hotel
1.11 Latitude Float Latitude Optional
information of
the
hotel
1.12 Longitude Float Longitude Optional
information of
the hotel
1.13 first_room_details" Array List[] Hotel first Room Mandatory'
details
1.13.1.1 Price Array List Hotel first Room
price details Mandatory
1.13.1.2 RoomPrice Decimal Price of the room Mandatory
1.13.1.3 Optional
Tax applicable for
the
Tax Decimal room
1.13.1.4 ExtraGuestCharge Extra Guest Optional
Charges
applicable for the
Decimal room
1.13.1.5 ChildCharge Decimal Child Charges Optional
applicable
for the room
1.13.1.6 OtherCharges Decimal Other Charges Optional
applicable
for the room
1.13.1.7 Discount Decimal Discount Optional
applicable for (Currently not in use)
the room
1.13.1.8 Mandatory
Published Price (This price would be
of the different only if Room
PublishedPrice room Price is on PUBLISHED.
In case of NET, Published
Price would be same as
Decimal Offered Price)
1.13.1.9 Integer Published Price Mandatory
PublishedPriceRounde dOff (rounded (This price is for display
off) of the room purpose only)
1.13.1.10 Decimal Offered Price of Mandatory
OfferedPrice
the room
1.13.1.11 Integer Offered Price Mandatory
OfferedPriceRoundedO ff (rounded (This price is for display
off) of the room purpose only)
1.13.1.12 Decimal Commission Optional
applicable (TBO will part this amount
AgentCommission
on the Room if Room Price is on
Price Published)
1.13.1.13 AgentMarkUp Decimal Optional
15
Agent Mark Up (Agent will earn this
applicable amount if Hotel markup is
on the Room set from backend)
Price
1.13.1.14 Optional
Agent Mark Up
ServiceTax applicable
on the Room
Decimal Price
1.13.1.15 Decimal TDS applicable Optional
TDS
on
1.13.1.16 String Price currency(Mandatory)
CurrencyCode
Price currency
1.13.2 Array List[] First Room Mandatory
cancellation_policy Cancellation
Policy
1.13.2.1 Decimal Cancellation Mandatory

Charge
Charge
1.13.2.2 Integer Mandatory
Cancellation
ChargeType 1-Cancellation Price
Charge Type
2-100% charge
1.13.2.3 String Mandatory
Currency 3 digit string
Cancellation Charge Currency
1.13.2.4 datetime Cancellation Mandatory
FromDate
Starting datetime
1.13.2.5 datetime Cancellation End Mandatory
ToDate
datetime
1.13.3 room_name String First Room Name Mandatory
1.13.4 Array List[] First Room data Mandatory
Room_data
List
1.13.4.1 String Used For Block Mandatory
RoomUniqueId
Room Request
1.13.4.2 String Room unique Mandatory
rate_key
rate key
1.13.4.3 String Room Group Mandatory
group_code
Code
1.13.5 Datetime First Room Mandatory
first_rm_cancel_date cancellation end
date
1.13.6 ArrayList[] First Room Optional
Amenities
Amenities
1.13.7 trip_adv_url Trip advisor Optional
rating Url
Provided by
String TripAdvisor
1.13.8 trip_rating TripAdvisor Rating count
Trip advisor provided by Tripvisor
Decimal Rating count Compay
16
7 .GETHOTELROOM
This method is used to request room details of a particular hotel based on ‘ResultToken’.
RoomDetailsResponse consists of Amenities, Bed Type details, refined cancellation
policies and other details of the hotel rooms. It also provides room combination details.

http://test.services.travelomatix.com/webservices/index.php/hotel_v3/service/RoomList
http://prod.services.travelomatix.com/webservices/index.php/hotel_v3/service/RoomList
Sample Request:
{
"ResultToken":"689071091692b535ae0539ecfa2d400a*_*6*_*kLgtCqf4zdtiyZ6h"
}
7.1 Hotel Room request

1 ResultToken String ResultToken Mandatory
(ResultToken to be
echoed back from
search response. This
can be used to trace
particular search/ book
at Travelomatix end)
Sample Response:
{
"Status": 1,
"Message": "",
"RoomList": {
"GetHotelRoomResult": {
"HotelRoomsDetails": [
{
"RoomUniqueId": "689071091692b535ae0539ecfa2d400a*_*284*_*zevfN9tGeFa4TQQ9",
"rate_key": "4hhfjnbw4ausjw2rv2iwohow4djkrsfl6szq",
"group_code": "wwnrp3l7wmrcpwsrusnwkhwr4u",
"room_code": "4pdfjnbi4ircpizpy2iw2hwv43gk6",
"ChildCount": 2,
"RoomTypeName": " 2 X Semi Deluxe",
"Price": {
"RoomPrice": 2766,
"Tax": 0,
17
"ChildCharge": 0,
"OtherCharges": 0,
"Discount": 0,
"AgentMarkUp": 0,
"ServiceTax": 0,
"TDS": 0,
"GSTPrice": 0,
},
"SmokingPreference": "NoPreference",
"RatePlanCode": "",
"RoomTypeCode": "",
"RatePlanName": " 2 X Semi Deluxe",
"Amenities": [
"Semi Deluxe"
],
"OtherAmennities": [
"Breakfast, Complimentary Wi-Fi Internet,"
],
"room_only": "room only",
"LastCancellationDate": "2018-06-10 12:41:11",
"CancellationPolicies": [
],
"CancellationPolicy": " 100% of total amount will be charged,if cancelled between 10-Jun-2018 12:41:11 and
27-Jun-2018 00:00:00|",
"HOTEL_CODE": "H!0299825",
"SEARCH_ID": "sn4acrnaocoxu3n2ny6r663v4y",
"RoomIndex": 0,
"InfoSource": "FixedCombination"
},
{
"RoomUniqueId": "689071091692b535ae0539ecfa2d400a*_*285*_*4CgFPHVjxF95iptN",
"rate_key": "4defzkr64qrcpw2uuooxshow5lmk7x5i6o76pu343nbqn7po",
"group_code": "wcmqxydh5arcvwkvukmg6",
"room_code": "4lhvdnri4ircpizpy2iw236uslmklq5c7g3ozwds3vcbv7pocpkx5b7reihcx27a6vkdo",
"ChildCount": 0,
"RoomTypeName": "2 X Deluxe Twin Room",
"Price": {
"RoomPrice": 3246,
"Tax": 0,
"ChildCharge": 0,
"OtherCharges": 0,
"Discount": 0,
"AgentMarkUp": 0,
"ServiceTax": 0,
"TDS": 0,
18
"GSTPrice": 0,
},
"RatePlanCode": "",
"RoomTypeCode": "",
"RatePlanName": "2 X Deluxe Twin Room",
"Amenities": [
"Breakfast"
],
],
{
"Charge": 3246,
"ChargeType": 1,
"Currency": "INR",
"FromDate": "2018-06-23 00:00:00",
"ToDate": "2018-06-27 00:00:00"
},
{
"Charge": 3246,
"ChargeType": 1,
"Currency": "INR",
"FromDate": "2018-06-22 00:00:00",
"ToDate": "2018-06-23 00:00:00"
},
{
"Charge": 0,
"ChargeType": 1,
"Currency": "INR",
"FromDate": "2018-06-10 12:41:11",
"ToDate": "2018-06-21 23:59:59"
}
],
"CancellationPolicy": "0 INR will be charged between 10-Jun-2018 and 21-Jun-2018 | 3244.98 INR will be
charged between 22-Jun-2018 and 23-Jun-2018 | 3244.98 INR will be charged between 23-Jun-2018 and 27-Jun-
2018 | |",
"HOTEL_CODE": "H!0299825",
"RoomIndex": 1,
},
{
"RoomUniqueId": "689071091692b535ae0539ecfa2d400a*_*286*_*PPQVqa9eiAb40ZG4",
"rate_key": "4hhfjnbw4ixs5wcuv2iwohow4hiknqfp6w2q",
"room_code": "4lffnnbi4ircpizpy2iw2gox4dgkw",
"ChildCount": 2,
"RoomTypeName": " 2 X Deluxe",
"Price": {
19
"RoomPrice": 3379,
"Tax": 0,
"ChildCharge": 0,
"OtherCharges": 0,
"Discount": 0,
"AgentMarkUp": 0,
"ServiceTax": 0,
"TDS": 0,
"GSTPrice": 0,
},
"RatePlanCode": "",
"RoomTypeCode": "",
"RatePlanName": " 2 X Deluxe",
"Amenities": [
"Deluxe - Best rate"
],
],
],
27-Jun-2018 00:00:00|",
"HOTEL_CODE": "H!0299825",
"RoomIndex": 2,
},
{
"RoomUniqueId": "689071091692b535ae0539ecfa2d400a*_*287*_*Fo80YhcfFjLkYMJA",
"rate_key": "4ddfjkrr4yrcpw2xvsoxsfot5lmk7x5i6o76pu353nban7pl",
"group_code": "wcmqxydh5arcvwkvukmg6",
"room_code": "4lgvhnzi4urcpizpy2iw236uslmklq5c7g3o7wds3vcbv7pocpkx5b7reihcx27a6vkdo",
"ChildCount": 0,
"RoomTypeName": "2 X Deluxe Double Room",
"Price": {
"RoomPrice": 3475,
"Tax": 0,
"ChildCharge": 0,
"OtherCharges": 0,
"Discount": 0,
20
"AgentMarkUp": 0,
"ServiceTax": 0,
"TDS": 0,
"GSTPrice": 0,
},
"RatePlanCode": "",
"RoomTypeCode": "",
"RatePlanName": "2 X Deluxe Double Room",
"Amenities": [
"Breakfast"
],
],
{
"Charge": 3474,
"ChargeType": 1,
"Currency": "INR",
"FromDate": "2018-06-23 00:00:00",
"ToDate": "2018-06-27 00:00:00"
},
{
"Charge": 3474,
"ChargeType": 1,
"Currency": "INR",
"FromDate": "2018-06-22 00:00:00",
"ToDate": "2018-06-23 00:00:00"
},
{
"Charge": 0,
"ChargeType": 1,
"Currency": "INR",
"FromDate": "2018-06-10 12:41:11",
"ToDate": "2018-06-21 23:59:59"
}
],
"CancellationPolicy": "0 INR will be charged between 10-Jun-2018 and 21-Jun-2018 | 3473.22 INR will be
charged between 22-Jun-2018 and 23-Jun-2018 | 3473.22 INR will be charged between 23-Jun-2018 and 27-Jun-
2018 | |",
"HOTEL_CODE": "H!0299825",
"RoomIndex": 3,
},
{
"RoomUniqueId": "689071091692b535ae0539ecfa2d400a*_*288*_*lTUfd61xSWncoJ0Y",
"rate_key": "4hhfjnbw4ixs5wcuv2iwohow4djkrsfl6syq",
"room_code": "4lefjnbi4ircpizpy2iw2gov4lgk6",
21
"ChildCount": 2,
"RoomTypeName": " 2 X Deluxe",
"Price": {
"RoomPrice": 3556,
"Tax": 0,
"ChildCharge": 0,
"OtherCharges": 0,
"Discount": 0,
"AgentMarkUp": 0,
"ServiceTax": 0,
"TDS": 0,
"GSTPrice": 0,
},
"RatePlanCode": "",
"RoomTypeCode": "",
"RatePlanName": " 2 X Deluxe",
"Amenities": [
"Deluxe Room"
],
],
],
27-Jun-2018 00:00:00|",
"HOTEL_CODE": "H!0299825",
"RoomIndex": 4,
}
],
"RoomCombinations": {
"InfoSource": "FixedCombination",
"IsPolicyPerStay": true,
"RoomCombination": [
{
"RoomIndex": [
0
]
},
{
"RoomIndex": [
1
22
]
},
{
"RoomIndex": [
2
]
},
{
"RoomIndex": [
3
]
},
{
"RoomIndex": [
4
]
}
]
}
}
}
}
7.2 GetHotelRoom Response
Level Element Comments Mandatory/

Format Optional
1 HotelRoomDetails [ ] ArrayList[] Hotel Roomdetails Mandatory
1.1.1 RoomUniqueId String Room unique id Mandatory
1.1.2 rate_key String Room rate key id Mandatory
1.1.3 group_code String Room group code Mandatory
1.1.4 room_code String Room code Mandatory
1.1.5 RoomIndex Integer Index of the room Mandatory
(referenced in
OptionsForBooking)
1.1.6 RatePlanCode String Rate plan code Optional
associated with
room
1.1.7 RatePlanName String Name of the Rate Optional
plan associated with
room
1.1.8 RoomTypeCode String Room Type Code Optional
associated with
room
1.1.9 RoomTypeName String Room Type Name Mandatory
1.1.10 InfoSource String Shows the format to Optional
select possible Possible values can
multiple be
room combinations FixedCombination,
to OpenCombination.
book
23
1.1.11 Price Array Price detail of the Mandatory
room
1.1.12 CurrencyCode String Currency in which Mandatory
minimum hotel
price is returned
1.1.14 Tax Decimal Tax applicable for Optional
the
room
applicable for the
room
1.1.16 ChildCharge Decimal Child Charges Optional
applicable for the
room
1.1.17 OtherCharge Decimal Other Charges Optional
applicable for the
room
1.1.18 Discount Decimal Discount applicable Optional (Currently
for the room not in use)
1.1.19 PublishedPrice Decimal Published Price of Mandatory
the (This price would be
room different only if
Room
Price is on
PUBLISHED.
In case of NET,
Published Price
would be
same as Offered
Price)
1.1.20 PublishedPriceRoundedOff Integer Published Price Mandatory
(rounded off) of the (This price is for
room display
purpose only)
1.1.21 OfferedPrice Decimal Offered Price of the Mandatory
room
1.1.22 OfferedPriceRoundedOff integer Offered Price Mandatory
(roundedoff) of the (This price is for
room display purpose only)
1.1.23 AgentCommission Decimal Optional (TBO will
part this amount if
Commission
applicable on the Room Price is on
Room Price Published)
1.1.24 AgentMarkUp Decimal Optional (Agent will
Agent Mark Up earn this amount if
applicable on the Hotel markup is set
Room Price from backend)
24
1.1.25 ServiceTax Decimal Service tax Mandatory
applicable for the
room
1.1.26 TDS Decimal TDS applicable on Optional (This would
Commission Earned be deducted only
when commission is
parted to the agent)
1.1.2 Amenities Array List List of room Optional
amenities
1.1.3 OtherAmennities Array List Hotel amenities
1.1.4 SmokingPreference String Smoking Preference Optional
associated with
room
1.1.5 LastCancellationDate Date Last Cancellation Mandatory
Date (No cancellation
charge
will be applied up to
this
date. If the date is
less
than book date then
cancellation charge
will
be applicable as per
policy)
Format:
(dd/mm/yyyy)
1.1.6 CancellationPolicies Array Array of Mandatory
cancellation
policies
1.1.6.1 Charge Decimal Mandatory
(Contains amount in
case
of Amount,
Percentage
value in case of
Percentage, No of
Cancellation nights
charge in case of Night)
1.1.6.2 ChargeType Cancellation charge Mandatory
Type - CancellationPolicies
- ChargeType
Amount = 1,
Enumeration Percentage = 2,
1.1.6.3 Currency String Base currency of Mandatory
Cancellation charge (Default currency
would
be INR)
1.1.6.4 FromDate Date Date from which Mandatory
charges will apply Format:
(dd/mm/yyyy)
25
1.1.6.5 ToDate Date Date up to which Mandatory
charges will apply Format:
(dd/mm/yyyy)
1.1.7 CancellationPolicy String Cancellation policy Mandatory
in text format (Format: Text)
1.1.8 RoomCombinations Array Array of Room Mandatory
options available to
book
1.1.8.1 InfoSource String Shows the format to Mandatory
select possible Possible values can
multiple room be
combinations to FixedCombination,
book OpenCombination.
1.1.8.2 RoomCombination Array Mandatory
1.1.8.3 RoomIndex IntegerArray Mandatory
8. BOOKING
This section will cover the methods useful for making a successful booking. Using these methods you
can verify price of your booking, you can make/hold a booking. You can also fetch details of your
booking (Successful case: You know your booking exist) or (Failure case: You want to know whether any
booking exist or not for your book request).
8.1 . BLOCKROOM
BlockRoom method is used to get the updated prices and cancellation policies for the selected
rooms before proceeding with the hotel booking. Block Room will also get the norms, if any.
1. This method should preferably be called before taking guest details from the client, so
that in case of any price change a proper intimation can be provided.
2. The price comparison is to be made at the client’s end, and BlockRoom request needs
to be sent again with the updated price and/ or updated cancellation policy.
http://test.services.travelomatix.com/webservices/index.php/hotel_v3/service/BlockRoom
http://prod.services.travelomatix.com/webservices/index.php/hotel_v3/service/BlockRoom
Sample Block Room Request:

{
26
"ResultToken": "598b913d10565e2c0a2df528157b039e*_*3*_*r0vluiA37WWLmyFL",
"RoomUniqueId": [
"598b913d10565e2c0a2df528157b039e*_*9*_*w34qKF4XJAvQG0UF"
]
}
8.1.1 Block room request

1 ResultToken ResultToken Mandatory
Return in Room
String response
2 RoomUniqueId RoomUnique Id Mandatory
Array return in response
8.1.2 BlockRoom Response
Level Element Format Comments Mandatory/Optional

1 IsPriceChanged Boolean Represent if price is Mandatory
changed or not (Would be set true, if
there
is a price change.
Would be set as false,
if
no price change)
2 IsCancellationPolicyChanged Boolean Represent if Mandatory
cancellation policy (Would be set true, if
is changed or not there is a change in
cancellation policy.
Would be set as false,
if no change in
cancellation policy)
3 HotelRoomsDetails Array List[] Array of hotel Mandatory
room details
3.1 RoomUniqueId string Room unique id Mandatory
3.2 room_code string Room code id
3.3 RoomIndex Integer Index of the room Mandatory
(referenced in
OptionsForBooking)
3.4 RatePlanCode String Rate plan code Optional
associated with
room
3.5 RoomTypeCode String Room Type Code Optional
3.6 RoomTypeName String Room Type Name Mandatory
3.7 Price Array Price detail of the Mandatory
room
3.7.1 CurrencyCode String Currency in which Mandatory
minimum hotel
price is returned
27
3.7.3 Tax Decimal Tax applicable for Optional
the room
applicable for the
room
3.7.5 ChildCharge Decimal Child Charges Optional
applicable for the
room
3.7.6 OtherCharges Decimal Other Charges Optional
applicable for the
room
3.7.7 Discount Decimal Discount applicable Optional
for the room (Currently not in use)
3.7.8 PublishedPrice Decimal Published Price of Mandatory

the room (This price would be
different only if Room
Price is on PUBLISHED
In case of NET,
Published
Price would be same
as
Offered Price )
3.7.9 PublishedPriceRoundedOff Integer Published Price Mandatory

(rounded off) of the (This price is for
room display
purpose only)
3.7.10 OfferedPrice Decimal Offered Price of Mandatory

the room
3.7.11 OfferedPriceRoundedOff Integer Mandatory
(This price is for
Offered Price display
(roundedoff) of purpose only)
the room
3.7.12 AgentCommission Decimal Commission Optional
applicable on the
Room Price (TBO will part this
amount
if Room Price is on
Published)
3.7.13 AgentMarkUp Decimal Agent Mark Up Optional

applicable on the (Agent will earn this
Room Price amount if Hotel
markup is
set from backend)
28
3.7.14 ServiceTax Decimal Service tax Mandatory
applicable for the
room
3.7.15 TDS Decimal TDS applicable on Optional
Commission Earned (This would be
deducted
only when commission
is
parted to the agent)
3.8 Boarding_details Array LIst List of room Optional

amenities
3.9 OtherAmennities String Room Other Optional

Amenities
3.10 SmokingPreference 1. Smoking Preference Optional
string associated with
room
3.11 LastCancellationDate DateTime Last Cancellation Mandatory
Date (No cancellation
charge
will be applied up to
this
date. If the date is
less
than book date then
cancellation charge
will be
applicable as per
policy)
Format: (dd-mm-
yyyy)
3.12 CancellationPolicies Array Array of Mandatory
cancellation
policies
3.12.1 Charge Decimal Cancellation charge Mandatory
(Contains amount in
case
of Amount,
Percentage
value in case of
Percentage, No of
nights
in case of Night)
3.12.2 ChargeType Enumeration Cancellation charge Mandatory
type CancellationPolicies
- ChargeType
Amount = 1,
Percentage = 2
29
3.12.3 Currency String Base currency of Mandatory
Cancellation charge (Default currency
would be INR)
3.12.4 FromDate Date Date from which Mandatory

charges will apply Format: (dd/mm/yyyy)
3.12.5 ToDate Date Date up to which Mandatory

charges will apply Format: (dd/mm/yyyy)
3.13 CancellationPolicy String Cancellation Policy Mandatory

in String (Format: Text)
3.14 SEARCH_ID String Search Id Mandatory
Block Room Repsonse:

{
"Status": 1,
"Message": "",
"BlockRoom": {
"BlockRoomResult": {
"HotelRoomsDetails": [
{
"Boarding_details": [
"Breakfast Continental"
],
"RoomUniqueId":
"YToxOntpOjA7YTo2OntzOjE0OiJib29raW5nX3NvdXJjZSI7czoxNjoiUFRCU0lEMDAwMDAwMDAyMCI7czo
3OiJUcmFjZUlkIjtzOjEyMDoiMTI2Mzc3XzI1NjY2NTE5MTJfMl8xMV8yXzFfMV8wXzI1NjY2NTE5NjBfMF80L
TUtMH40LTUtMF8zLTEwMC4yMDE4MDYyNl8xXzItNS03fjFfMF8xMDRfNjYzNjhjNTBkNzNiNGI4NmJiZDUy
YTdkNDMzOGQ2YjJfIjtzOjExOiJQcm9kdWN0Q29kZSI7czoxMjA6IjEyNjM3N18yNTY2NjUxOTEyXzJfMTFfMl
8xXzFfMF8yNTY2NjUxOTYwXzBfNC01LTB+NC01LTBfMy0xMDAuMjAxODA2MjZfMV8yLTUtN34xXzBfMTA
0XzY2MzY4YzUwZDczYjRiODZiYmQ1MmE3ZDQzMzhkNmIyXyI7czo4OiJSb29tQ29kZSI7czoxMjA6IjEyNjM3
N18yNTY2NjUxOTEyXzJfMTFfMl8xXzFfMF8yNTY2NjUxOTYwXzBfNC01LTB+NC01LTBfMy0xMDAuMjAxOD
A2MjZfMV8yLTUtN34xXzBfMTA0XzY2MzY4YzUwZDczYjRiODZiYmQ1MmE3ZDQzMzhkNmIyXyI7czo4OiJS
b29tVHlwZSI7czo5OiIyIHggU3VpdGUiO3M6ODoicmF0ZV9rZXkiO3M6MTIwOiIxMjYzNzdfMjU2NjY1MTkx
Ml8yXzExXzJfMV8xXzBfMjU2NjY1MTk2MF8wXzQtNS0wfjQtNS0wXzMtMTAwLjIwMTgwNjI2XzFfMi01LTd
+MV8wXzEwNF82NjM2OGM1MGQ3M2I0Yjg2YmJkNTJhN2Q0MzM4ZDZiMl8iO319",
"room_code": "126377_2566651912_2_11_2_1_1_0_2566651960_0_4-5-0~4-5-0_3-
100.20180626_1_2-5-7~1_0_104_66368c50d73b4b86bbd52a7d4338d6b2_",
"RoomTypeName": "2 x Suite",
"Price": {
"RoomPrice": 11125,
"Tax": 0,
30
"ChildCharge": 0,
"OtherCharges": 0,
"Discount": 0,
"AgentMarkUp": 0,
"ServiceTax": 0,
"TDS": 0,
"GSTPrice": 0,
},
"RatePlanCode": "Executive Suite,Executive Suite",
"RatePlanType": "QB,QB",
"rate_key": "126377_2566651912_2_11_2_1_1_0_2566651960_0_4-5-0~4-5-0_3-
100.20180626_1_2-5-7~1_0_104_66368c50d73b4b86bbd52a7d4338d6b2_",
"RoomCount": 2,
"ChildCount": 2,
"HotelCode": "126377",
"RoomTypeCode": "",
"OtherAmennities": "",
{
"FromDate": "10-06-2018",
"ToDate": "22-06-2018",
"Currency": "INR",
"Charge": 0,
"ChargeType": 1
},
{
"FromDate": "23-06-2018",
"ToDate": "26-06-2018",
"Currency": "INR",
"Charge": 22250,
"ChargeType": 1
}
],
"CancellationPolicy": "0 INR will be charged between 10-06-2018 and 22-06-2018 || 22250 INR will
be charged between 23-06-2018 and 26-06-2018",
"LastCancellationDate": "22-06-2018",
"RoomIndex": 0,
"TM_Cancellation_Charge": [
{
"FromDate": "10-06-2018",
"ToDate": "22-06-2018",
"Currency": "INR",
"Charge": 0,
"ChargeType": 1
},
{
31
"FromDate": "23-06-2018",
"ToDate": "26-06-2018",
"Currency": "INR",
"Charge": 22250,
"ChargeType": 1
}
],
"AccessKey": "xyz",
"API_raw_price": "347.65",
"SEARCH_ID": "126377_2566651912_2_11_2_1_1_0_2566651960_0_4-5-0~4-5-0_3-
100.20180626_1_2-5-7~1_0_104_66368c50d73b4b86bbd52a7d4338d6b2_"
},
{
"Boarding_details": [
"Breakfast Continental"
],
"RoomUniqueId":
"YToxOntpOjA7YTo2OntzOjE0OiJib29raW5nX3NvdXJjZSI7czoxNjoiUFRCU0lEMDAwMDAwMDAyMCI7czo
3OiJUcmFjZUlkIjtzOjEyMDoiMTI2Mzc3XzI1NjY2NTE5MTJfMl8xMV8yXzFfMV8wXzI1NjY2NTE5NjBfMF80L
TUtMH40LTUtMF8zLTEwMC4yMDE4MDYyNl8xXzItNS03fjFfMF8xMDRfNjYzNjhjNTBkNzNiNGI4NmJiZDUy
YTdkNDMzOGQ2YjJfIjtzOjExOiJQcm9kdWN0Q29kZSI7czoxMjA6IjEyNjM3N18yNTY2NjUxOTEyXzJfMTFfMl
8xXzFfMF8yNTY2NjUxOTYwXzBfNC01LTB+NC01LTBfMy0xMDAuMjAxODA2MjZfMV8yLTUtN34xXzBfMTA
0XzY2MzY4YzUwZDczYjRiODZiYmQ1MmE3ZDQzMzhkNmIyXyI7czo4OiJSb29tQ29kZSI7czoxMjA6IjEyNjM3
N18yNTY2NjUxOTEyXzJfMTFfMl8xXzFfMF8yNTY2NjUxOTYwXzBfNC01LTB+NC01LTBfMy0xMDAuMjAxOD
A2MjZfMV8yLTUtN34xXzBfMTA0XzY2MzY4YzUwZDczYjRiODZiYmQ1MmE3ZDQzMzhkNmIyXyI7czo4OiJS
b29tVHlwZSI7czo5OiIyIHggU3VpdGUiO3M6ODoicmF0ZV9rZXkiO3M6MTIwOiIxMjYzNzdfMjU2NjY1MTkx
Ml8yXzExXzJfMV8xXzBfMjU2NjY1MTk2MF8wXzQtNS0wfjQtNS0wXzMtMTAwLjIwMTgwNjI2XzFfMi01LTd
+MV8wXzEwNF82NjM2OGM1MGQ3M2I0Yjg2YmJkNTJhN2Q0MzM4ZDZiMl8iO319",
"room_code": "126377_2566651912_2_11_2_1_1_0_2566651960_0_4-5-0~4-5-0_3-
100.20180626_1_2-5-7~1_0_104_66368c50d73b4b86bbd52a7d4338d6b2_",
"RoomTypeName": "2 x Suite",
"Price": {
"RoomPrice": 11125,
"Tax": 0,
"ChildCharge": 0,
"OtherCharges": 0,
"Discount": 0,
"AgentMarkUp": 0,
"ServiceTax": 0,
"TDS": 0,
"GSTPrice": 0,
},
32
"RatePlanCode": "Executive Suite,Executive Suite",
"RatePlanType": "QB,QB",
"rate_key": "126377_2566651912_2_11_2_1_1_0_2566651960_0_4-5-0~4-5-0_3-
100.20180626_1_2-5-7~1_0_104_66368c50d73b4b86bbd52a7d4338d6b2_",
"RoomCount": 2,
"ChildCount": 2,
"HotelCode": "126377",
"RoomTypeCode": "",
"OtherAmennities": "",
{
"FromDate": "10-06-2018",
"ToDate": "22-06-2018",
"Currency": "INR",
"Charge": 0,
"ChargeType": 1
},
{
"FromDate": "23-06-2018",
"ToDate": "26-06-2018",
"Currency": "INR",
"Charge": 22250,
"ChargeType": 1
}
],
"CancellationPolicy": "0 INR will be charged between 10-06-2018 and 22-06-2018 || 22250 INR will
be charged between 23-06-2018 and 26-06-2018",
"LastCancellationDate": "22-06-2018",
"RoomIndex": 1,
"TM_Cancellation_Charge": [
{
"FromDate": "10-06-2018",
"ToDate": "22-06-2018",
"Currency": "INR",
"Charge": 0,
"ChargeType": 1
},
{
"FromDate": "23-06-2018",
"ToDate": "26-06-2018",
"Currency": "INR",
"Charge": 22250,
"ChargeType": 1
}
],
"SEARCH_ID": "126377_2566651912_2_11_2_1_1_0_2566651960_0_4-5-0~4-5-0_3-
100.20180626_1_2-5-7~1_0_104_66368c50d73b4b86bbd52a7d4338d6b2_"
}
],
"BlockRoomId": "598b913d10565e2c0a2df528157b039e*_*11*_*CpzuUUrxD0FpKAWL",
"IsPriceChanged": false,
33
"IsCancellationPolicyChanged": false
}
}
}
8.2 BOOK
Book method is called to either hold a booking or to book and voucher a booking based on
the selected rooms and guest information. We strongly recommend checking the updated
prices and cancellation policies for the selected rooms through BlockRoom method before
proceeding with the hotel booking to reduce the probability of booking failure.
Instead of 'Confirmed' you might get ‘Hold’as BookingStatus for some bookings. This is
because some of the suppliers do not provide confirmation of the booking immediately. In
this case you need to call HotelBookingDetail method after few minutes (15-20) to get the
updated status.
Service URL (REST) to be used:TEST

http://test.services.travelomatix.com/webservices/index.php/hotel_v3/service/CommitBooking
Service URL (REST) to be used:LIVE

http://prod.services.travelomatix.com/webservices/index.php/hotel_v3/service/CommitBooking
Sample Request:
{
"ResultToken": "560b1806eab47a57561e442bad5770f3*_*3*_*XJlPOG6edEEFfxSJ",
"BlockRoomId": "560b1806eab47a57561e442bad5770f3*_*6*_*FJJ6d35DN1VgkEwt",
"AppReference": "HB10-125738-495363",
"RoomDetails": [
{
"PassengerDetails": [
{
"Title": "Ms",
"FirstName": "Anitha",
"MiddleName": "",
"LastName": "gangapatnam",
"Phoneno": "9000983418",
"Email": "anitha.g.provab@gmail.com",
"PaxType": "1",
"LeadPassenger": true,
"Age": 30
},
{
"Title": "Mr",
"FirstName": "Anil",
"MiddleName": "",
34
"Phoneno": "9000983418",
"PaxType": "1",
"LeadPassenger": false,
"Age": 30
},
{
"Title": "Mstr",
"FirstName": "sai",
"MiddleName": "",
"LastName": "gangapatanm",
"Phoneno": "9000983418",
"PaxType": "2",
"Age": 5
},
{
"Title": "Mstr",
"FirstName": "harisai",
"MiddleName": "",
"LastName": "gangapatanm",
"Phoneno": "9000983418",
"PaxType": "2",
"Age": 7
}
]
},
{
"PassengerDetails": [
{
"Title": "Ms",
"FirstName": "Haritha",
"MiddleName": "",
"Phoneno": "9000983418",
"PaxType": "1",
"LeadPassenger": true,
"Age": 30
}
]
}
]
}
8.2.1 BOOK REQUEST
Level Element Format Comments Mandatory/

Optional
35
1 ResultToken String Result Token returned in Mandatory
block Room response
2 BlockRoomId String Unique BlockRoomId Mandatory
3 AppReference String Unique Booking Mandatory
AppReference
4 RoomDetails Array Array of hotel room details
4.1 PassengerDetails Array Array of guest details
for in the particular
room as requested in
Array
4.1.1 Title String Title of the guest Mandatory
Possible values
can be
Mr, Mrs,Mstr
4.1.2 FirstName String First name of the guest Mandatory
(Min 2 chars, Max
50
chars)
4.1.3 MiddleName String Middle name of the Optional
4.1.4 LastName String Last name of the guest Mandatory

(Min 2 chars, Max
50
chars)
4.1.5 Email String Guest Email id Mandatory
4.1.6 PaxType Enumeration Guest Type Mandatory
HotelPassenger
- PaxType
Adult = 1,
Child = 2
4.1.7 LeadPassenger LeadPassenger Represent the lead Mandatory
guest of the booking (Set true if the
guest is a
lead passenger.
Set false, if the
guest is
not a lead
passenger)
4.1.8 Age Integer Age of the guest Mandatory *
(only for child and
age
should be <= 18
years)
8.2.2 Book Response in Case of Successful Booking
36
1 Status Enumeration Booking Mandatory
status Possible values can be
0 – BookFailed,
1 - Confirmed,
2 Message String Booking Optional

response
message
3 CommitBooking array Hotel Mandatory
Booking
details
3.1 BookingDetails array Hotel Mandatory

Booking
details
3.1.1 BookingId String Unique Mandatory

Hotel
Booking Id
3.1.2 BookingRefNo String Booking Mandatory
Reference
Number
3.1.3 ConfirmationNo String Unique Mandatory

confirmation
number of
the
successful
3.1.4 booking_status String Booking BOOKING_CONFIRMED,BOOKING_HOLD,BO

Status of the OKING_FAILED
booking
Book Response in case of successful booking
{
"Status": 1,
"Message": "",
"CommitBooking": {
"BookingDetails": {
"ConfirmationNo": "BLUURDVSG9UJ",
"BookingRefNo": "BLUURDVSG9UJ",
"BookingId": "TM-309612904|1234,1235",
"SupplierVatId": "",
37
"booking_status": "BOOKING_CONFIRMED"
}
}
}
Book Response in case of hold
{
"Status": 1,
"Message": "",
"CommitBooking": {
"BookingDetails": {
"ConfirmationNo": "TM",
"BookingRefNo": "TM",
"BookingId": "TM-",
"SupplierVatId": "",
"booking_status": "BOOKING_HOLD "
}
}
}
9. HotelBookingDetail
This API request used to check hold booking status.

http://test.services.travelomatix.com/webservices/index.php/hotel_v3/service/UpdateHoldBooking
http://prod.services.travelomatix.com/webservices/index.php/hotel_v3/service/UpdateHoldBookin
g
GetBookingDetail Request:
{
AppReference:”HB-22052018-4564654”
}
9.1 Getbooking detail request

Optional
1 app_reference String Hotel Booking Mandatory
Reference
GetBookingdetails Response:
38
{
"Status": 1,
"Message": "Hotel Hold Booking Status",
"UpdateHoldBooking":
{
"booking_id": "TM-4ti5nre662rcx5htyelra64p6q"
}
}
9.2 GetBookingdetails Response:

Optional
1 Status Boolean Response Status Mandatory
2 Message String Reponse Message Optional
3 UpdateHoldBooking Array UpdateHoldBooking Mandatory
contains booking Id
3.1 booking_id String Hotel Booking Mandatory
Confirmation
Number
10. CANCEL BOOKING

This API is used for cancel the hotel booking.

http://test.services.travelomatix.com/webservices/index.php/hotel_v3/service/CancelBooking
http://prod.services.travelomatix.com/webservices/index.php/hotel_v3/service/CancelBooking
CancelRequest
{"AppReference":"HB10-130820-197161"}
10.1 Cancel request

Optional
Reference
39
CANCELBOOKINGRESPONSE:
{
"Status": 1,
"Message": "",
"CancelBooking": {
"CancellationDetails": {
"StatusDescription": "Processed",
"ChangeRequestId": 3,
"RefundedAmount": 22250,
"CancellationCharge": 0,
"ChangeRequestStatus": "Processed"
}
}
}
10.2 Cancel Response

Optional
3 CancelBooking Array Cancellation Mandatory
Booking array list
3.1 CancellationDetails Array Cancellation Mandatory
Booking array list
3.1.1 StatusDescription String Cancellation Mandatory
Refund status
Two types of
desctiption:
1.Inprogress
2.Processed
Processed –
cancellation process
done amount
refunded to
travelomatix
account
3.1.2 ChangeRequestId Interger Hotel booking Mandatory

amount refund
status Same as
“StatusDescription”
3.1.3 RefundedAmount Decimal Hotel Booking Mandatory
Refund amount cancellation refund
amount
3.1.4 CancellationCharge Decimal Hotel Booking Mandatory
Cancellaiton cancellation charge
Charge
40
3.1.5 ChangeRequestStatus String Mandatory
Same as
11. GETCANCELLATIONREFUNDDETAILS
This API used to check cancellation refund amount.

http://test.services.travelomatix.com/webservices/index.php/hotel_v3/service/CancellationRefund
Details
http://prod.services.travelomatix.com/webservices/index.php/hotel_v3/service/CancellationRefund
Details
CANCELLATIONREFUND REQUEST:
{
"ChangeRequestId": “2”,
“AppReference":” HB10-130820-197161”
}
11.1 CANCELLATIONREFUND REQUEST:

Optional
1 ChangeRequestId Integer Change Request Id,
Received from Mandatory
cancel booking
response
Reference
CANCELLATIONREFUND RESPONSE:
{
"Status": 1,
"Message": "",
"RefundDetails": {
"StatusDescription": "Processed",
"ChangeRequestId": 3,
"RefundedAmount": 22250,
"CancellationCharge": 0,
41
"ChangeRequestStatus": "Processed"
}
}
15. CERTIFICATION
11.2 CANCELLATIONREFUND RESPONSE:

Optional
3 RefundDetails Array Cancellation Mandatory
Booking array list
3.1 StatusDescription String Cancellation Mandatory
Refund status
Two types of
desctiption:
1.Inprogress
2.Processed
Processed –
cancellation process
done amount
refunded to
travelomatix
account
3.2 ChangeRequestId Interger Hotel booking Mandatory

amount refund
status Same as
3.3 RefundedAmount Decimal Hotel Booking Mandatory
Refund amount cancellation refund
amount
3.4 CancellationCharge Decimal Hotel Booking Mandatory
Cancellaiton cancellation charge
Charge
3.5 ChangeRequestStatus String Mandatory

Same as
42

Travelomatix Hotel Api Documentation Final

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Travelomatix Hotel Api Documentation Final

Uploaded by

Copyright:

Available Formats

Technical Guide

Presented By: Accentria Solutions.

Document Guidelines Index

9).2 GetBookingdetails Response: ………………………………………………………………… 39

10) CANCEL BOOKING……………………………………………………………………………………….. 39

10)1 Cancel request …………………………………………………………………………………… 39

10)2 Cancel Response………………………………………………………………………………… 40

11).1 CANCELLATIONREFUND REQUEST: …………………………………………………… 41

11). 2 CANCELLATIONREFUND RESPONSE: ………………………………………………………… 42

3.0 10/06/2018 New documentation file

Phone: +91 8066210050

New features added in Travelomatix Hotel API

This is RESTFUL service which communicates only in JSON Format.

Schema optimization for all the methods to reduce request/response size

New method to verify hold booking request

 Gets all the available Hotels for the requested

 Gets all hotel details like description,

 Gets all the available rooms with their prices and

 Gets hotel booking done for selected

 Gets the booking information based on the Confirmation

HOTEL  Used to cancel a reservation

Please check the below steps on how to receive compressed response.

Step 1: Request must contain the header as "Accept-Encoding:gzip, deflate".

Step 2: If server detects, the response will be compressed.

Step 3: Client receives response with the header "Content-Encoding: gzip".

Step 4: Client needs to decompress the Response before processing.

x-Username -- test or production Username (travelomatix will be provide)

1. 'RoomGuest' will repeat for multiple rooms search.

2. Child age(s) are compulsory when search request includes child.

Service URL (REST) to be used: TEST

Service URL (REST) to be used: LIVE

Sample Search Request

1 Room with 2 adults

5.1 HotelSearch Request

Level Element Format Comments Mandatory/ Optional

Sample Search Responce

5.2 Hotel Search Response

Level Element Format Comments Mandatory/ Optional

2.4 HotelCategory String Hotel Category Optional

Service URL (REST) to be used: TEST

Service URL (REST) to be used: LIVE

6.1 Hotelinfo Request

Level Element Format Comments Mandatory/Optional

6.3 Hotelinfo Response

Level Element Format Comments Mandatory/ Optional

1.13.2.1 Decimal Cancellation Mandatory

Service URL (REST) to be used: TEST

7.1 Hotel Room request

Level Element Format Comments Mandatory/ Optional

7.2 GetHotelRoom Response

Level Element Comments Mandatory/

Service URL (REST) to be used: TEST

Service URL (REST) to be used: LIVE

Sample Block Room Request:

Level Element Format Comments Mandatory/ Optional

8.1.2 BlockRoom Response

Level Element Format Comments Mandatory/Optional

3.7.8 PublishedPrice Decimal Published Price of Mandatory

3.7.9 PublishedPriceRoundedOff Integer Published Price Mandatory

3.7.10 OfferedPrice Decimal Offered Price of Mandatory

3.7.13 AgentMarkUp Decimal Agent Mark Up Optional

3.8 Boarding_details Array LIst List of room Optional