Retrieve Hotel Reservation API Reference
|
Get |
book/reservations/{AggregatorLocatorCode} For {AggregatorLocatorCode} send the locator code returned at booking or in Reservation Retrieve in Receipt/Confirmation/Locator/value. Hotel bookings return multiple locator codes. Send the value from the instance of Receipt with Confirmation/Locator/locatorType=PNR Locator. See Locator Codes for details.
Use this base path if you have not yet received or not migrated to the new credentials from Travelport:
Use this base path after you have migrated to the new credentials from Travelport (using .net instead of .com):
|
Related Content: JSON Hotel APIs Guide, Hotel Workflows, Create Hotel Reservation API Reference
The Retrieve Hotel Reservation API returns all existing data on a reservation.
Request
As part of the request requirements, also see Authentication and Common Hotel API Headers.
Query Parameters
None.
Request Body
This API does not send a message payload.
Response
The Retrieve Reservation response returns the same type of data using the same structure as the response to Create Reservation. See the Create Reservation Reference Payload API Reference for documentation.
Examples
For additional examples, download the developer toolkits and see Using Postman and Developer Toolkits.
The following example retrieves a reservation with one active segment, identified as offer O1.
Example
{
"ReservationResponse": {
"Reservation": {
"@type": "ReservationDetail",
"Offer": [
{
"@type": "Offer",
"id": "O1",
"Identifier": {
"value": "6269ddc1-a017-40cb-bce6-140d5e74e104:cc3280205f5ae9a9b7944c1002c88b33",
"authority": "TVPT"
},
"Product": [
{
"@type": "ProductHospitality",
"Quantity": 1,
"bookingCode": "T00AABT",
"guests": 1,
"adaCompliant": "No",
"propertyName": "SpringHill Suites by Marriott Grand Rapids Airport Southeast",
"associatedCityCode": "GRR",
"associatedAirportCode": "GRR",
"PropertyAddress": {
"@type": "Address",
"AddressLine": [
"5250 28th St. SE"
],
"City": "Grand Rapids",
"StateProv": {
"value": "MI"
},
"Country": {
"name": "US"
},
"PostalCode": "49512"
},
"Telephone": {
"@type": "Telephone",
"phoneNumber": "464-1130",
"cityCode": "GRR"
},
"GuestCounts": {
"GuestCount": [
{
"count": 1,
"ageQualifyingCode": "10"
}
]
},
"PropertyKey": {
"@type": "PropertyKey",
"chainCode": "XV",
"propertyCode": "89550"
},
"TravelerContact": {
"@type": "TravelerContact",
"Email": {
"value": "matt.singh@galileo.co.in"
},
"Telephone": {
"@type": "Telephone",
"countryAccessCode": "91",
"areaCityCode": "011",
"phoneNumber": "9891766469",
"cityCode": "HDQ"
}
},
"RoomType": {
"@type": "RoomTypeDetail",
"RoomCharacteristics": {
"@type": "RoomCharacteristics",
"typeCode": "3",
"smokingAllowed": "No",
"wifiIncluded": "No",
"BedConfiguration": [
{
"quantity": 2,
"bedType": "Queen Bed(s)",
"size": "160 cm X 200 cm"
}
],
"accessibleRoom": "No"
},
"Description": {
"value": "AAA Caa Hot Deals, Membership Card Required, Suite, 2 Queen"
}
},
"DateRange": {
"start": "2025-10-16",
"end": "2025-10-17"
}
}
],
"Price": {
"@type": "PriceDetail",
"CurrencyCode": {
"value": "USD",
"decimalPlace": 2
},
"Base": 121.5,
"TotalTaxes": 21.87,
"TotalPrice": 143.37,
"PriceBreakdown": [
{
"@type": "PriceBreakdownHospitality",
"Amount": {
"@type": "Amount",
"CurrencyCode": {
"value": "USD",
"decimalPlace": 2
},
"Base": 121.5,
"Taxes": {
"@type": "TaxesDetail",
"TotalTaxes": 21.87,
"Tax": [
{
"value": 21.87,
"currencyCode": "USD",
"taxCode": "08",
"purpose": "Lodging tax",
"description": "Lodging tax",
"includedInBase": "No"
}
]
},
"Total": 143.37
},
"Commission": {
"@type": "Commission",
"application": "Commissionable"
},
"roomPricingType": "Per stay",
"Description": "Best Available Rate"
},
{
"@type": "PriceBreakdownHospitality",
"roomPricingType": "Per night",
"NightlyRate": [
{
"@type": "NightlyRate",
"startDate": "2025-10-16",
"nights": 1,
"Amount": {
"@type": "Amount",
"CurrencyCode": {
"value": "USD",
"decimalPlace": 2
},
"Base": 121.5,
"Taxes": {
"@type": "TaxesDetail",
"TotalTaxes": 21.87,
"Tax": [
{
"value": 21.87,
"currencyCode": "USD",
"taxCode": "08",
"purpose": "Lodging tax",
"description": "Lodging tax",
"includedInBase": "No"
}
]
},
"Total": 143.37
}
}
],
"AverageNightlyRate": [
{
"value": 121.5,
"code": "USD"
}
]
}
]
},
"TermsAndConditionsFull": [
{
"@type": "TermsAndConditionsFullHospitality",
"CustomerLoyalty": [
{
"value": "1111111",
"supplierType": "Hotel"
},
{
"value": "222222",
"programId": "IT",
"supplierType": "Air"
}
],
"TextBlock": [
{
"@type": "TextBlock",
"title": "Location",
"TextFormatted": [
{
"value": "Directions: *From Grr Airport Turn Right Onto Patterson. Turn Right Onto 33Rd Street. Turn Left Into The Hotel Entrance. * From Downtown Take I-96 To Exit 43. Turn Right On 28Th Street. Turn Left At The 1St Traffic Light Which Is Hotel Avenue. The Hotel Is Behind Target."
}
]
}
],
"Guarantee": [
{
"@type": "Guarantee",
"guaranteeType": "GuaranteeRequired"
}
],
"CancelPenalty": [
{
"@type": "CancelPenalty",
"Deadline": {
"@type": "Deadline",
"SpecificDate": {
"start": "2025-09-16",
"end": "2025-10-15"
},
"Time": "23:59:59"
},
"HotelPenalty": {
"@type": "HotelPenaltyPercent",
"appliesTo": "Amount",
"Percent": 0
},
"Refundable": "Yes"
},
{
"@type": "CancelPenalty",
"Deadline": {
"@type": "Deadline",
"SpecificDate": {
"start": "2025-10-16"
}
},
"HotelPenalty": {
"@type": "HotelPenaltyAmount",
"Amount": [
{
"value": 143.37,
"code": "USD"
}
]
},
"Refundable": "No"
}
],
"Description": [
"T00Aabt: AAA Caa Hot Deals Membership Card Required",
"Suite 2 Queen",
"2 Queen Mini Fridge",
"Microwave 450 Square Feet/41 Square Metre Living/Sitting Area",
"Wireless Internet Complimentary"
],
"ProductRateCodeInfo": [
{
"RateCodeInfo": {
"rateCategory": "Association"
}
}
],
"RatePaymentInfo": "PostPay",
"CustomerLoyaltyIDRequiredAtReservation": false,
"RateQualificationIDRequiredAtCheckIn": true
}
],
"passiveOfferInd": false
}
],
"Traveler": [
{
"@type": "Traveler",
"id": "T1",
"PersonName": {
"@type": "PersonName",
"Given": "Bear",
"Surname": "Das"
},
"Telephone": [
{
"@type": "Telephone",
"countryAccessCode": "91",
"areaCityCode": "011",
"phoneNumber": "9891766469",
"cityCode": "HDQ"
}
],
"Email": [
{
"value": "matt.singh@nope.com"
}
],
"CustomerLoyalty": [
{
"value": "1111111",
"supplierType": "Hotel"
},
{
"value": "222222",
"programId": "IT",
"supplierType": "Air"
}
]
}
],
"TravelerProduct": [
{
"@type": "TravelerProduct",
"TravelerRef": "T1",
"OfferRef": "O1"
}
],
"FormOfPayment": [
{
"@type": "FormOfPaymentPaymentCard",
"id": "FOP1",
"PaymentCard": {
"@type": "PaymentCard",
"expireDate": "1125",
"CardCode": "VI",
"CardHolderName": "Frank Sinatra",
"CardNumber": {
"@type": "CardNumber",
"PlainText": "************1111"
}
}
}
],
"Payment": [
{
"@type": "Payment",
"Amount": {
"value": 143.37,
"code": "USD"
},
"FormOfPaymentIdentifier": {
"Identifier": {
"value": "FOP1"
}
},
"OfferIdentifier": [
{
"Identifier": {
"value": "O1"
}
}
]
}
],
"Receipt": [
{
"@type": "ReceiptConfirmation",
"OfferRef": [
"O1"
],
"Confirmation": {
"@type": "ConfirmationHold",
"Locator": {
"value": "80073065",
"locatorType": "Confirmation Number",
"source": "XV",
"sourceContext": "Supplier",
"creationDate": "2025-09-16"
},
"OfferStatus": {
"@type": "OfferStatusHospitality",
"code": "HK",
"Status": "Confirmed"
}
}
},
{
"@type": "ReceiptConfirmation",
"OfferRef": [
"O1"
],
"Confirmation": {
"@type": "ConfirmationHold",
"Locator": {
"value": "96120603",
"locatorType": "IATA Number",
"sourceContext": "Agency",
"creationDate": "2025-09-16"
},
"OfferStatus": {
"@type": "OfferStatusHospitality",
"Status": "Confirmed"
}
}
},
{
"@type": "ReceiptConfirmation",
"Confirmation": {
"@type": "ConfirmationHold",
"Locator": {
"value": "D6VBHL",
"locatorType": "PNR Locator",
"sourceContext": "Travelport",
"creationDate": "2025-09-16"
},
"OfferStatus": {
"@type": "OfferStatusHospitality",
"Status": "Confirmed"
}
}
}
],
"ReservationComment": [
{
"@type": "ReservationComment",
"Comment": [
{
"value": "No charge to CC",
"name": "Special Instruction"
}
],
"AppliesTo": [
{
"@type": "AppliesToOffer",
"OfferIdentifier": [
{
"offerRef": "O1"
}
]
}
]
},
{
"@type": "ReservationComment",
"commentSource": "Supplier",
"shareWith": "Agency",
"Comment": [
{
"value": "CXL:PERMITTED UP TO 01 DAYS BEFORE ARRIVAL INVALID/CF-80073065",
"name": "OSI REMARKS"
}
],
"AppliesTo": [
{
"@type": "AppliesToOffer",
"OfferIdentifier": [
{
"offerRef": "O1"
}
]
}
]
}
]
},
"traceId": "25fb1289-7079-4151-b51e-a201cb83ffcc"
}
}
The next example retrieves a reservation that has one active segment and one placeholder passive segment. The active segment is returned as the first offer and identified as offer O1. All information related only to that segment, such as form of payment and specific comments, is also identified with offer O1. The passive segment is returned as offer O2 and all information related to it is identified with offer O2. Note that for readability the TermsAndConditionsFull/TextBlock objects were truncated [...].
Example with active and passive segments and remarks
{"ReservationResponse": {
"Reservation": {
"@type": "ReservationDetail",
"Offer": [
{
"@type": "Offer",
"id": "O1",
"Identifier": {
"value": "6269ddc1-a017-40cb-bce6-140d5e74e104:cc3280205f5ae9a9b7944c1002c88b33",
"authority": "TVPT"
},
"Product": [
{
"@type": "ProductHospitality",
"Quantity": 1,
"bookingCode": "T00AABT",
"guests": 1,
"adaCompliant": "No",
"propertyName": "SpringHill Suites by Marriott Grand Rapids Airport Southeast",
"associatedCityCode": "GRR",
"associatedAirportCode": "GRR",
"PropertyAddress": {
"@type": "Address",
"AddressLine": [
"5250 28th St. SE"
],
"City": "Grand Rapids",
"StateProv": {
"value": "MI"
},
"Country": {
"name": "US"
},
"PostalCode": "49512"
},
"Telephone": {
"@type": "Telephone",
"phoneNumber": "464-1130",
"cityCode": "GRR"
},
"GuestCounts": {
"GuestCount": [
{
"count": 1,
"ageQualifyingCode": "10"
}
]
},
"PropertyKey": {
"@type": "PropertyKey",
"chainCode": "XV",
"propertyCode": "89550"
},
"TravelerContact": {
"@type": "TravelerContact",
"Email": {
"value": "matt.singh@galileo.co.in"
},
"Telephone": {
"@type": "Telephone",
"countryAccessCode": "91",
"areaCityCode": "011",
"phoneNumber": "9891766469",
"cityCode": "HDQ"
}
},
"RoomType": {
"@type": "RoomTypeDetail",
"RoomCharacteristics": {
"@type": "RoomCharacteristics",
"typeCode": "3",
"smokingAllowed": "No",
"wifiIncluded": "No",
"BedConfiguration": [
{
"quantity": 2,
"bedType": "Queen Bed(s)",
"size": "160 cm X 200 cm"
}
],
"accessibleRoom": "No"
},
"Description": {
"value": "AAA Caa Hot Deals, Membership Card Required, Suite, 2 Queen"
}
},
"DateRange": {
"start": "2025-10-16",
"end": "2025-10-17"
}
}
],
"Price": {
"@type": "PriceDetail",
"CurrencyCode": {
"value": "USD",
"decimalPlace": 2
},
"Base": 121.5,
"TotalTaxes": 21.87,
"TotalPrice": 143.37,
"PriceBreakdown": [
{
"@type": "PriceBreakdownHospitality",
"Amount": {
"@type": "Amount",
"CurrencyCode": {
"value": "USD",
"decimalPlace": 2
},
"Base": 121.5,
"Taxes": {
"@type": "TaxesDetail",
"TotalTaxes": 21.87,
"Tax": [
{
"value": 21.87,
"currencyCode": "USD",
"taxCode": "08",
"purpose": "Lodging tax",
"description": "Lodging tax",
"includedInBase": "No"
}
]
},
"Total": 143.37
},
"Commission": {
"@type": "Commission",
"application": "Commissionable"
},
"roomPricingType": "Per stay",
"Description": "Best Available Rate"
},
{
"@type": "PriceBreakdownHospitality",
"roomPricingType": "Per night",
"NightlyRate": [
{
"@type": "NightlyRate",
"startDate": "2025-10-16",
"nights": 1,
"Amount": {
"@type": "Amount",
"CurrencyCode": {
"value": "USD",
"decimalPlace": 2
},
"Base": 121.5,
"Taxes": {
"@type": "TaxesDetail",
"TotalTaxes": 21.87,
"Tax": [
{
"value": 21.87,
"currencyCode": "USD",
"taxCode": "08",
"purpose": "Lodging tax",
"description": "Lodging tax",
"includedInBase": "No"
}
]
},
"Total": 143.37
}
}
],
"AverageNightlyRate": [
{
"value": 121.5,
"code": "USD"
}
]
}
]
},
"TermsAndConditionsFull": [
{
"@type": "TermsAndConditionsFullHospitality",
"CustomerLoyalty": [
{
"value": "1111111",
"supplierType": "Hotel"
},
{
"value": "222222",
"programId": "IT",
"supplierType": "Air"
}
],
"TextBlock": [...],
"Guarantee": [
{
"@type": "Guarantee",
"guaranteeType": "GuaranteeRequired"
}
],
"CancelPenalty": [
{
"@type": "CancelPenalty",
"Deadline": {
"@type": "Deadline",
"SpecificDate": {
"start": "2025-09-16",
"end": "2025-10-15"
},
"Time": "23:59:59"
},
"HotelPenalty": {
"@type": "HotelPenaltyPercent",
"appliesTo": "Amount",
"Percent": 0
},
"Refundable": "Yes"
},
{
"@type": "CancelPenalty",
"Deadline": {
"@type": "Deadline",
"SpecificDate": {
"start": "2025-10-16"
}
},
"HotelPenalty": {
"@type": "HotelPenaltyAmount",
"Amount": [
{
"value": 143.37,
"code": "USD"
}
]
},
"Refundable": "No"
}
],
"Description": [
"T00Aabt: AAA Caa Hot Deals Membership Card Required",
"Suite 2 Queen",
"2 Queen Mini Fridge",
"Microwave 450 Square Feet/41 Square Metre Living/Sitting Area",
"Wireless Internet Complimentary"
],
"ProductRateCodeInfo": [
{
"RateCodeInfo": {
"rateCategory": "Association"
}
}
],
"RatePaymentInfo": "PostPay",
"CustomerLoyaltyIDRequiredAtReservation": false,
"RateQualificationIDRequiredAtCheckIn": true
}
],
"passiveOfferInd": false
},
{
"@type": "Offer",
"id": "O2",
"Identifier": {
"authority": "TVPT"
},
"Product": [
{
"@type": "ProductHospitality",
"Quantity": 1,
"DateRange": {
"start": "2026-06-11",
"end": "2026-06-12"
}
}
],
"TermsAndConditionsFull": [
{
"@type": "TermsAndConditionsFullHospitality",
"TextBlock": [
{
"@type": "TextBlock",
"title": "Passive supplementary text",
"TextFormatted": [
{
"value": "/H-RETENTION/R-TVPT999/BC-U/TRAVELPORT FUTURES PROJECT"
}
]
}
],
"Guarantee": [
{
"@type": "Guarantee",
"guaranteeType": "DepositRequired"
}
]
}
],
"passiveOfferInd": true
},
],
"Traveler": [
{
"@type": "Traveler",
"id": "T1",
"PersonName": {
"@type": "PersonName",
"Given": "Bear",
"Surname": "Das"
},
"Telephone": [
{
"@type": "Telephone",
"countryAccessCode": "91",
"areaCityCode": "011",
"phoneNumber": "9891766469",
"cityCode": "HDQ"
}
],
"Email": [
{
"value": "matt.singh@galileo.co.in"
}
],
"CustomerLoyalty": [
{
"value": "1111111",
"supplierType": "Hotel"
},
{
"value": "222222",
"programId": "IT",
"supplierType": "Air"
}
]
}
],
"TravelerProduct": [
{
"@type": "TravelerProduct",
"TravelerRef": "T1",
"OfferRef": "O1"
}
],
"FormOfPayment": [
{
"@type": "FormOfPaymentPaymentCard",
"id": "FOP1",
"PaymentCard": {
"@type": "PaymentCard",
"expireDate": "1125",
"CardCode": "VI",
"CardHolderName": "Frank Sinatra",
"CardNumber": {
"@type": "CardNumber",
"PlainText": "************1111"
}
}
}
],
"Payment": [
{
"@type": "Payment",
"Amount": {
"value": 143.37,
"code": "USD"
},
"FormOfPaymentIdentifier": {
"Identifier": {
"value": "FOP1"
}
},
"OfferIdentifier": [
{
"Identifier": {
"value": "O1"
}
}
]
}
],
"Receipt": [
{
"@type": "ReceiptConfirmation",
"OfferRef": [
"O1"
],
"Confirmation": {
"@type": "ConfirmationHold",
"Locator": {
"value": "80073065",
"locatorType": "Confirmation Number",
"source": "XV",
"sourceContext": "Supplier",
"creationDate": "2025-09-16"
},
"OfferStatus": {
"@type": "OfferStatusHospitality",
"code": "HK",
"Status": "Confirmed"
}
}
},
{
"@type": "ReceiptConfirmation",
"OfferRef": [
"O1"
],
"Confirmation": {
"@type": "ConfirmationHold",
"Locator": {
"value": "96120603",
"locatorType": "IATA Number",
"sourceContext": "Agency",
"creationDate": "2025-09-16"
},
"OfferStatus": {
"@type": "OfferStatusHospitality",
"Status": "Confirmed"
}
}
},
{
"@type": "ReceiptConfirmation",
"OfferRef": [
"O2"
],
"Confirmation": {
"@type": "ConfirmationHold",
"OfferStatus": {
"@type": "OfferStatusHospitality",
"code": "AK",
"Status": "Confirmed"
}
}
},
{
"@type": "ReceiptConfirmation",
"Confirmation": {
"@type": "ConfirmationHold",
"Locator": {
"value": "D6VBHL",
"locatorType": "PNR Locator",
"sourceContext": "Travelport",
"creationDate": "2025-09-16"
},
"OfferStatus": {
"@type": "OfferStatusHospitality",
"Status": "Confirmed"
}
}
}
],
"ReservationComment": [
{
"@type": "ReservationComment",
"Comment": [
{
"value": "No charge to CC",
"name": "Special Instruction"
}
],
"AppliesTo": [
{
"@type": "AppliesToOffer",
"OfferIdentifier": [
{
"offerRef": "O1"
}
]
}
]
},
{
"@type": "ReservationComment",
"commentSource": "Supplier",
"shareWith": "Agency",
"Comment": [
{
"value": "CXL:PERMITTED UP TO 01 DAYS BEFORE ARRIVAL INVALID/CF-80073065",
"name": "OSI REMARKS"
}
],
"AppliesTo": [
{
"@type": "AppliesToOffer",
"OfferIdentifier": [
{
"offerRef": "O1"
}
]
}
]
}
]
},
"traceId": "8c0ff96b-b0d9-493d-83a4-a3fb8cbc943f"
}
}