Attention: Please check the Hotel Release Notes page for the latest updates and enhancements.
Retrieve Hotel Reservation API Reference
Get |
book/reservations/{LocatorCode} For {LocatorCode} send the locator code of the reservation to retrieve (returned in the workbench commit in Confirmation/Locator/value). Base path: Pre-production https://api.pp.travelport.com/11/hotel/ Production https://api.travelport.com/11/hotel/ |
Related Content: Hotel Guide, Create Hotel Reservation API Reference
The Hotel Retrieve API returns traveler and hotel reservation information from an existing PNR in the Travelport system.
Request
Also see Authorization and Common Headers.
Query Parameters
None.
Request Body
None.
Response
The response to the Retrieve Reservation request returns the updated information using the same structure as the response to Create Reservation.
Example Request
GET https://api.pp.travelport.com/11/hotel/book/reservations/2BQ55R
Example Response
{
"ReservationResponse": {
"Reservation": {
"@type": "ReservationDetail",
"id": "513ea814-8a27-4145-a1df-ee07fb34d824",
"Offer": [
{
"@type": "Offer",
"id": "O1",
"Identifier": {
"authority": "EXPE"
},
"Product": [
{
"@type": "ProductHospitality",
"Quantity": 1,
"bookingCode": "C2D0007",
"guests": 1,
"PropertyKey": {
"chainCode": "BX",
"propertyCode": "16798"
},
"DateRange": {
"start": "2022-11-11",
"end": "2022-11-14"
}
}
],
"Price": {
"@type": "PriceDetail",
"CurrencyCode": {
"value": "DKK",
"decimalPlace": 2
},
"TotalPrice": 1650.0
},
"TermsAndConditionsFull": [
{
"@type": "TermsAndConditionsFullHospitality",
"Guarantee": [
{
"guaranteeType": "GuaranteeRequired"
}
],
"CancelPenalty": [
{
"Deadline": {
"SpecificDate": {
"start": "2022-09-09",
"end": "2022-11-10"
},
"Time": "18:00:00"
},
"HotelPenalty": {
"@type": "HotelPenaltyAmount",
"Amount": [
{
"value": 0.0,
"code": "DKK"
}
]
},
"Refundable": "Yes"
},
{
"Deadline": {
"SpecificDate": {
"start": "2022-11-10"
},
"Time": "18:00:00"
},
"HotelPenalty": {
"@type": "HotelPenaltyAmount",
"Amount": [
{
"value": 550.0,
"code": "DKK"
}
]
},
"Refundable": "No"
}
],
"RatePaymentInfo": "PostPay"
}
]
},
{
"@type": "Offer",
"id": "O2",
"Identifier": {
"authority": "TVPT"
},
"Product": [
{
"@type": "ProductHospitality",
"Quantity": 1,
"bookingCode": "C2D0007",
"guests": 1,
"PropertyKey": {
"chainCode": "BX",
"propertyCode": "16798"
},
"DateRange": {
"start": "2022-11-11",
"end": "2022-11-14"
}
}
],
"Price": {
"@type": "PriceDetail",
"CurrencyCode": {
"value": "DKK",
"decimalPlace": 2
},
"TotalPrice": 1650.0
},
"TermsAndConditionsFull": [
{
"@type": "TermsAndConditionsFullHospitality",
"Guarantee": [
{
"guaranteeType": "GuaranteeRequired"
}
],
"CancelPenalty": [
{
"Deadline": {
"SpecificDate": {
"start": "2022-09-09",
"end": "2022-11-10"
},
"Time": "18:00:00"
},
"HotelPenalty": {
"@type": "HotelPenaltyAmount",
"Amount": [
{
"value": 0.0,
"code": "DKK"
}
]
},
"Refundable": "Yes"
},
{
"Deadline": {
"SpecificDate": {
"start": "2022-11-10"
},
"Time": "18:00:00"
},
"HotelPenalty": {
"@type": "HotelPenaltyAmount",
"Amount": [
{
"value": 550.0,
"code": "DKK"
}
]
},
"Refundable": "No"
}
],
"RatePaymentInfo": "PostPay"
}
]
},
{
"@type": "Offer",
"id": "O3",
"Identifier": {
"authority": "TVPT"
},
"Product": [
{
"@type": "ProductHospitality",
"Quantity": 1,
"bookingCode": "C2D0007",
"guests": 1,
"PropertyKey": {
"chainCode": "BX",
"propertyCode": "16798"
},
"DateRange": {
"start": "2022-11-14",
"end": "2022-11-15"
}
}
],
"Price": {
"@type": "PriceDetail",
"CurrencyCode": {
"value": "DKK",
"decimalPlace": 2
},
"TotalPrice": 1650.0
},
"TermsAndConditionsFull": [
{
"@type": "TermsAndConditionsFullHospitality",
"Guarantee": [
{
"guaranteeType": "GuaranteeRequired"
}
],
"CancelPenalty": [
{
"Deadline": {
"SpecificDate": {
"start": "2022-09-09",
"end": "2022-11-10"
},
"Time": "18:00:00"
},
"HotelPenalty": {
"@type": "HotelPenaltyAmount",
"Amount": [
{
"value": 0.0,
"code": "DKK"
}
]
},
"Refundable": "Yes"
},
{
"Deadline": {
"SpecificDate": {
"start": "2022-11-10"
},
"Time": "18:00:00"
},
"HotelPenalty": {
"@type": "HotelPenaltyAmount",
"Amount": [
{
"value": 550.0,
"code": "DKK"
}
]
},
"Refundable": "No"
}
],
"RatePaymentInfo": "PostPay"
}
]
}
],
"Traveler": [
{
"@type": "Traveler",
"id": "T1",
"PersonName": {
"@type": "PersonName",
"Given": "NAMEA",
"Surname": "SURNAMEA"
},
"Telephone": [
{
"@type": "Telephone",
"phoneNumber": "011-11111111",
"cityCode": "DEN"
},
{
"@type": "Telephone",
"phoneNumber": "011-222222222",
"cityCode": "DEN"
},
{
"@type": "Telephone",
"phoneNumber": "011-333333333",
"cityCode": "DEN"
}
],
"Email": [
{
"value": "test1@test.com"
}
],
"CustomerLoyalty": [
{
"value": "ogramId1Value1",
"programId": "Pr"
}
]
},
{
"@type": "Traveler",
"id": "T2",
"PersonName": {
"@type": "PersonName",
"Given": "NAMEB",
"Surname": "SURNAMEB"
},
"Email": [
{
"value": "test2@test.com"
}
]
},
{
"@type": "Traveler",
"id": "T3",
"PersonName": {
"@type": "PersonName",
"Given": "NAMEC",
"Surname": "SURNAMEC"
},
"Email": [
{
"value": "test3@test.com"
}
]
}
],
"TravelerProduct": [
{
"@type": "TravelerProduct",
"TravelerRef": "T2",
"OfferRef": "O1"
}
},
{
"@type": "TravelerProduct",
"TravelerRef": "T1",
"OfferRef": "O2"
}
},
{
"@type": "TravelerProduct",
"TravelerRef": "T3",
"OfferRef": "O3"
}
}
],
"Receipt": [
{
"@type": "ReceiptConfirmation",
"OfferRef": [
"O1"
],
"Confirmation": {
"@type": "ConfirmationHold",
"Locator": {
"value": "GAL784155606",
"locatorType": "Confirmation Number",
"source": "BX",
"sourceContext": "Supplier"
},
"OfferStatus":
"@type": "OfferStatusHospitality",
"Status": "Confirmed"
}
}
},
{
"@type": "ReceiptConfirmation",
"OfferRef": [
"O2"
],
"Confirmation": {
"@type": "ConfirmationHold",
"Locator": {
"value": "GAL144635594",
"locatorType": "Confirmation Number",
"source": "BX",
"sourceContext": "Supplier"
},
"OfferStatus": {
"@type": "OfferStatusHospitality",
"Status": "Confirmed"
}
}
},
{
"@type": "ReceiptConfirmation",
"OfferRef": [
"O3"
],
"Confirmation": {
"@type": "ConfirmationHold",
"Locator": {
"value": "GAL328547179",
"locatorType": "Confirmation Number",
"source": "BX",
"sourceContext": "Supplier"
},
"OfferStatus": {
"@type": "OfferStatusHospitality",
"Status": "Confirmed"
}
}
},
{
"@type": "ReceiptConfirmation",
"Confirmation": {
"@type": "ConfirmationHold",
"Locator": {
"value": "2BQ55R",
"locatorType": "PNR Locator",
"sourceContext": "Travelport"
},
"OfferStatus": {
"@type": "OfferStatusHospitality",
"Status": "Confirmed"
}
}
}
],
"ReservationComment": [
{
"@type": "ReservationComment",
"Comment": [
{
"value": "Please dont charge CC"
}
],
"AppliesTo": [
{
"@type": "AppliesToOffer",
"OfferIdentifier": [
{
"@type": "OfferID",
"offerRef": "O1"
}
]
}
]
},
{
"@type": "ReservationComment",
"Comment": [
{
"value": "Please dont charge CC modified"
}
],
"AppliesTo": [
{
"@type": "AppliesToOffer",
"OfferIdentifier": [
{
"@type": "OfferID",
"offerRef": "O2"
}
]
}
]
},
{
"@type": "ReservationComment",
"Comment": [
{
"value": "lower floor room please Test"
}
],
"AppliesTo": [
{
"@type": "AppliesToOffer",
"OfferIdentifier": [
{
"@type": "OfferID",
"offerRef": "O3"
}
]
}
]
}
]
}
}
}
Error Messages
Error message for Hotel Retrieve API.
SourceCode | StatusCode (HTTP code) | Message |
---|---|---|
|
400 |
Not able to reach IDM Authorization atomic or Authorization cannot be identified due to insufficient inputs |
|
400 |
Provider Locator must be provided. |
|
400 |
Unable to process Retrieve request: Invalid Record Locator Number. |
|
401 |
Unathorised user. |
|
500 |
null |