Retrieve Booking
Discover how to use Retrieve API calls to retrieve existing itineraries. This can be called directly with your API key with booking reference id. It returns details about a booking details associated with the itinerary id along with cancel links to cancel the booking.
Parameters
Name
Description
Accept
string
( header )
Must be application/json
Accept - Encoding
string
( header )
Must be gzip
Authorization
string
( header )
Must be Your PID
Must be Your API Key
Customer-Ip
string
( header )
Must be IP address of the customer, as captured by your integration. Send IPV4 addresses only.
Ensure your integration passes the customer’s IP, not your own. This value helps determine their location and other settings.
Also used for fraud recovery and other important analytics.
action
string
( query )
Must be "getBookDetails" as parameter
Action methods in Web API controller can have one or more parameters of different types. It can be either primitive type or complex type. Web API binds action method parameters either with URL's query string or with request body depending on the parameter type.
apiKey
string
( query )
Must be a valid API Key
The API Key provided to you is critical to the security of your request data – treat it like a password. Never include the raw value in any publicly accessible site or app code. You will be provided with an API key when you are approved to integrate TPS API.
ModeType
string
( query )
Must be either "Test" or "LIVE"
Your application must be approved from Adivaha Personnel. All the transactions will be treated as LIVE once the parameter is set to LIVE.
requestBody
array
( query )
Must be an array with the following parameters
BookingId
string
( query )
The BookingId ID generated at the time of booking.
itineraryId
string
( query )
The Itinerary ID generated at the time of booking.
REQUEST
API Endpoint: https://your-end-point/api/v1/travel-api/hotels/
header: array(
'Content-Type:application/json',
'Accept-encoding: gzip',
'PID:'ADD-YOUR-PID',
'x-api-key:'ADD-YOUR-KEY'
);
POST:
{
"action": "getBookDetails",
"mode": "Test",
"itineraryId": "346896543",
"BookingId": "31620301"
}
Response
The API returns an HTTP response, which generally includes the result of the request invocation
{
"Status": 600,
"status_message": "Booking has been confirmed ",
"responseData": {
"GetBookingDetailResult": {
"VoucherStatus": true,
"ResponseStatus": 1,
"Error": {
"ErrorCode": 0,
"ErrorMessage": ""
},
"TraceId": "3b62998f-46dc-4482-bf79-23619a6f221f",
"Status": 1,
"HotelBookingStatus": "Confirmed",
"ConfirmationNo": "FLLBBV(7253958265303)",
"BookingRefNo": "432493301682594",
"BookingId": 1614235,
"IsPriceChanged": false,
"IsCancellationPolicyChanged": false,
"HotelRoomsDetails": [
{
"AdultCount": 1,
"AvailabilityType": "Confirm",
"ChildCount": 0,
"HotelPassenger": [
{
"Age": 0,
"Email": "test@thewebconz.com",
"FirstName": "Abhishek",
"GSTCompanyAddress": null,
"GSTCompanyContactNumber": null,
"GSTCompanyEmail": null,
"GSTCompanyName": null,
"GSTNumber": null,
"LastName": "Sharma",
"LeadPassenger": true,
"MiddleName": "",
"PAN": null,
"PassportExpDate": null,
"PassportIssueDate": null,
"PassportNo": null,
"PaxId": 139023,
"PaxType": 1,
"Phoneno": "08877665544",
"Title": "Mr"
}
],
"RequireAllPaxDetails": false,
"RoomId": 107348,
"RoomStatus": 0,
"RoomIndex": 1,
"RoomTypeCode": "202414827|",
"RoomDescription": "",
"RoomTypeName": "Double Room (Non Ac),2 Twin Beds,Nonsmoking",
"RatePlanCode": "202414827|212286584|37341",
"RatePlan": 0,
"DayRates": [
{
"Amount": 1501.32,
"Date": "2020-07-09T00:00:00"
}
],
"IsPerStay": false,
"SupplierPrice": null,
"Price": {
"CurrencyCode": "INR",
"RoomPrice": 1501.32,
"Tax": 179.97,
"ExtraGuestCharge": 0,
"ChildCharge": 0,
"OtherCharges": 420.63,
"Discount": 0,
"PublishedPrice": 2101.92,
"PublishedPriceRoundedOff": 2102,
"OfferedPrice": 2101.92,
"OfferedPriceRoundedOff": 2102,
"AgentCommission": 0,
"AgentMarkUp": 0,
"ServiceTax": 75.7,
"TDS": 0,
"ServiceCharge": 0,
"TotalGSTAmount": 75.7,
"GST": {
"CGSTAmount": 0,
"CGSTRate": 0.00,
"CessAmount": 0,
"CessRate": 0.00,
"IGSTAmount": 75.7,
"IGSTRate": 18.00,
"SGSTAmount": 0,
"SGSTRate": 0.00,
"TaxableAmount": 420.63
}
},
"RoomPromotion": "",
"Amenities": [
"Room Only"
],
"Amenity": [
"Room Only"
],
"SmokingPreference": "NoPreference",
"BedTypes": [
],
"HotelSupplements": null,
"LastCancellationDate": "2020-07-06T23:59:59",
"CancellationPolicies": [
{
"Charge": 100.0000,
"ChargeType": 2,
"Currency": "INR",
"FromDate": "2020-07-07T00:00:00",
"ToDate": "2020-07-10T23:59:59"
}
],
"LastVoucherDate": "2020-07-07T00:00:00",
"CancellationPolicy": "Double Room (Non Ac),2 Twin Beds,Nonsmoking#^#100.00% of total amount will be charged, If cancelled between 07-Jul-2020 00:00:00 and 10-Jul-2020 23:59:59.|#!#",
"Inclusion": [
"Room Only"
]
}
],
"AgentRemarks": "",
"BookingSource": "TBOHApi3",
"GuestNationality": "IN",
"HotelPolicyDetail": "india - land of mystries \"\/\/\" \" \/\/\/ \" |CheckIn Time-Begin: 12:00 PM CheckIn Time-End: 12:00 PMCheckOut Time: 11:00 AMCheckIn Instructions: Extra-person charges may apply and vary depending on property policy. <br \/>Government-issued photo identification and a credit card, debit card, or cash deposit may be required at check-in for incidental charges. <br \/>Special requests are subject to availability upon check-in and may incur additional charges. Special requests cannot be guaranteed. <ul> Only bookings from non-local guests are accepted. Guests whose residence is within the same city as the property will not be allowed to check in. Please note that cultural norms and guest policies may differ by country and by property. The policies listed are provided by the property. <\/ul> Special Instructions : Front desk staff will greet guests on arrival. For more details, please contact the property using the information on the booking confirmation. Please note that PAN cards are not accepted as identification at this property.Minimum CheckIn Age : 18 Optional Fees: <p>The following fees and deposits are charged by the property at time of service, check-in, or check-out. <\/p> <ul> <li>Rollaway bed fee: INR 300 per night<\/li> <\/ul> <p>The above list may not be comprehensive. Fees and deposits may not include tax and are subject to change. <\/p>Cards Accepted: Mastercard,Visa<ul> <li>Couples wishing to share a room must provide proof of marriage. <\/li><li>Only registered guests are allowed in the guestrooms. <\/li> <\/ul>,Pets not allowed,No cribs (infant beds) availablePlease refer to the following Terms of Use - http:\/\/mytravelagent.online\/termsofuse.pdfPlease note that bedding type will be Early check out will attract full cancellation charge unless otherwise specified.|",
"IntHotelPassportDetails": null,
"InvoiceAmount": 2178,
"InvoiceCreatedOn": "2020-07-07T11:56:15",
"InvoiceNo": "MW\/2021\/3122",
"IsCorporate": false,
"HotelConfirmationNo": null,
"HotelCode": "1124262",
"HotelId": 93619,
"HotelName": "Dreamland Hotel",
"TBOHotelCode": "",
"StarRating": 2,
"AddressLine1": "163 P D'Mello Road,Fort,Mumbai,Maharashtra,IN",
"AddressLine2": "Phone No: 91-22-2261775",
"CountryCode": "IN",
"Latitude": "18.946796",
"Longitude": "72.8401",
"City": "Mumbai",
"CityId": 144306,
"CheckInDate": "2020-07-09T00:00:00",
"InitialCheckInDate": "2020-07-09T00:00:00",
"CheckOutDate": "2020-07-10T00:00:00",
"InitialCheckOutDate": "2020-07-10T00:00:00",
"LastCancellationDate": "2020-07-06T23:59:59",
"LastVoucherDate": "2020-07-07T00:00:00",
"NoOfRooms": 1,
"BookingDate": "2020-07-07T11:56:14",
"SpecialRequest": "",
"IsDomestic": true,
"FlightInfo": "Ab 777|#2020-12-20T18:18:00",
"BookingAllowedForRoamer": true
}
}
}