Booking Summary API

This API provides detailed information about a booking. It can also be used to verify the booking status to confirm the booking.

Request

Parameter	Type	Mandatory	Description
source	String	Y	Travel seller ID
token	String	N	Partner unique request id at the time of booking request
confirmationNumber	String	N	Booking confirmation number if available
propertyCode	String	Y	Property code (Format = TP041778, TP = brand code & 041778 = hotel code)

Note:

1. Either of the tokens or confirmation number is mandatory in the request.

2. In case both token and confirmationNumber are present, confirmationNumber takes precedence over the token. And booking will be retrieved against the confirmation number. If no booking is found against the confirmation number, then the booking will be searched against the token. If no booking is found, an error will be returned.

Sample Request

{

"source": "TGX_MB",

"token": "TOKEN123",

"confirmationNumber": "CONFNUM123",

"propertyCode": "TP041778"

}

Response

Parameter	Type	Mandatory	Description
token	String	Y	Partner unique request id at the time of booking request.
propertyCode	String	Y	Property code (Format = TP041778, TP = brand code & 041778 = hotel code)
inDate	Date	Y	Check-in date. Format YYYY-MM-DD
outDate	Date	Y	Check-out date. Format YYYY-MM-DD
ratePlanCode	String	Y	Rate plan code
roomTypeCode	String	Y	Room type code
numberOfRooms	Integer	Y	Number or rooms
numberOfAdults	Integer	Y	Number of adults
numberOfChildren	Integer	Y	Number of children
firstName	String	Y	Primary Guest First Name
lastName	String	Y	Primary Guest Last Name
totalRateInclusive	Decimal	Y	Total rate including tax
totalTax	Decimal	Y	Total taxes
currenyCode	String	Y	Currency code (for ex: “USD”)
bookingStatus	Enum	Y	Booking status (Possible values : "BOOKED", “FAILED” or “CANCELLED” )
confirmationNumber	String	N	Booking confirmation number
bookingDateTime	Timestamp	Y	Booking time (Format : 2024-11-18 10:55:10)
cancellationNumber	String	N	Booking cancellation number
cancelPolicy	String	N	Cancellation policy description
cancelDateTime	Timestamp	N	Cancellation time (Format : 2024-11-18 10:55:10)
specialRequest	String	N	Special request
error	Object	N	Present only for error response
code	String	Y	Error code
description	String	Y	Error Description

Sample Response

{

"token": "jhfr3i",

"propertyCode": "TP041677",

"inDate": "18-11-2024",

"outDate": "20-11-2024",

"ratePlanCode": "ABC",

"roomTypeCode": "KLQ",

"numberOfRooms": "1",

"numberOfAdults": "2",

"numberOfChildren": "0",

"firstName": "AK",

"lastName": "Gupta",

"totalRateInclusive": "160.00",

"totalTax": "29.53",

"currencyCode": "USD",

"bookingStatus": "BOOKED",

"confirmationNumber": "CONFNUM123",

"bookingDateTime": "2024-11-18 10:55:10",

"cancellationNumber": "CANCNUM123",

"cancelPolicy": "CANCEL BY 1800 20241118 LOCAL PROPERTY TIME TO AVOID PENALTIES",

"cancelDateTime": "2024-11-18 10:55:10",

"specialRequest": "EXTRA BED"

}

Sample Error Response

{

"error": {

"code": "SD400",

"description": "No record found"

}

}