Modify Hotel Reservation API Reference
Put |
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
Use Modify Hotel Reservation to modify specific data on an existing booking. Modify Hotel supports changes to the following data:
-
Dates of reservation, if allowed by supplier; note that a change in price may occur
-
Form of payment details
-
Specific details of the traveler associated with a booking as follows:
-
Changing the given name and/or surname to that of another traveler currently on the reservation; other name changes are not supported
-
Telephone number
-
Email address
-
-
Adding new comments
Request
Query Parameters
None.
Request Body
The example request modifies the dates on an existing reservation.
ReservationDetail*
Top level object for Modify Reservation request. Must include Receipt object to send confirmation and locator details of current booking.
May include Traveler, Offer, Form of Payment, and ReservationComment objects depending on the data to be modified.
Receipt*
Top level object for reservation confirmation and locator details. Includes Confirmation object.
Confirmation*
Confirmation details. Includes ConfirmationStatus and Locator objects.
ConfirmationStatus*
String. Status associated to the sold hotel segment. Send the value from the Create Reservation response:
Receipt/Confirmation/ConfirmationStatus
Locator*
Top level object for locator details.
locatorType* : String. Send the value from the Create Reservation response:
Receipt/Confirmation/ConfirmationStatus/Locator/locatorType
source* : String. Content source. Supplier code. Send the value from the Create Reservation response:
Receipt/Confirmation/ConfirmationStatus/Locator/source
sourceContext* : String. Send the value from the Create Reservation response:
Receipt/Confirmation/ConfirmationStatus/Locator/sourceContext
value* : String. The supplier confirmation number. Send the value from the Create Reservation response:
Receipt/Confirmation/ConfirmationStatus/Locator/value
Traveler
Send if modifying traveler details.

Traveler* to modify traveler details
Traveler details. May include PersonName, Telephone, and Email objects.
PersonName* to modify traveler name
Traveler name.
Given* to modify given name : String. Updated traveler first name.
Surname* to modify surname : String. Updated traveler last name.
Telephone* to modify telephone
Traveler telephone details.
phoneNumber* to modify telephone : String. Phone number.
areaCityCode* to modify telephone : String. Phone local area code.
countryAccessCode : String. Phone country code.
cityCode : String. Phone city code.
Email* to modify email
Traveler email address.
value : String. Traveler email address.
Offer
Send if modifying dates of stay.

Offer* to change reservation dates
Top level object used when changing reservation dates. Includes Product object.
Product* to change reservation dates
Details about stay dates. Includes DateRange object.
DateRange* to change reservation dates
Check-in and -out dates.
start* to change start date : String. Check-in date in YYYY-MM-DD format.
end* to change end date : String. Check-out date in YYYY-MM-DD format.
specific : String. Same day check-in and -out date in YYYY-MM-DD format.

FormOfPayment*
Top level object for form of payment details. Send if modifying form of payment details.
Includes PaymentCard.
PaymentCard*
Form of payment details.
Includes CardNumber, SeriesCode, Telephone, and Address objects.
expireDate* : String. Credit card expiration date in MMYY format.
CardType* : String. Type of card including Credit, Debit, and Gift.
CardCode * : String. Code for credit card type.
CardHolderName* : String. Name on credit card.
CardNumber*
Card number details.
PlainText* : String. Credit card number.
SeriesCode
Security code of card.
PlainText* for certain suppliers : String. The credit card three- or four-digit CVV code.
CardNumber*
Card number details.
PlainText* : String. Credit card number.
SeriesCode
Security code of card.
PlainText* for certain suppliers : String. The credit card three- or four-digit CVV code.

ReservationComment
Send optional top level object if adding comments.
Modify supports adding these types of remarks:
-
Notepad remarks, including general, historical, and confidential
-
Unassociated remarks
-
Associated remarks
-
Special Instruction remarks
-
Accounting remarks
Includes Comment and AppliesTo objects.
commentSource* : Originator of comment. Accepted value: Agency.
shareWith* : Designates visibility of remark.
Notepad remarks: Agency
Unassociated remarks: Traveler
Associated remarks: Traveler
Special instructions: Supplier
Comment*
Array of name/value pairs.
name* : Type of remark.
Notepad remarks: 2 character code. Use asterisk for any placeholder. (HS, CR, R*, **)
Unassociated remarks: ITIN COMMENTS
Associated remarks: ITIN COMMENTS
Special instruction remarks: SI
value* : String. Remark text. Limits:
Notepad remarks: 87 characters
Unassociated remarks: 70 characters
Associated remarks: 70 characters
Special instruction remarks: 50 characters
AppliesTo* for associated remarks
Only used with associated remarks. Top level object to designate which hotel segments to link a remark.
OfferIdentifier* for associated remarks
Object for hotel segment offer number.
offerRef* for associated remarks : Specific offer ID number associated to the hotel segment. Perform a RETRIEVE message first to validate the correct offer ID number if you have multiple hotel segments in the PNR.
Accounting
Optional top level object used for all DOCI remarks. Includes NameValuePair object.
dataType* : Accounting remark designator. Accepted value: DOCI.
NameValuePair*
Array of name/value pairs.
name* : Type of remark. Accepted values:
DYO Design Your Own Itinerary FS Fare Saver CR Canned Remarks TK Ticket Number Details AC Agent, Account, or Branch Details AR Replace Sign On Code X* Back Office Accounting Details FT Free Text value* : String. Text to pair with name values above. Text limitations for each name value are listed below.
DYO 2 digit, numeric FS 9 characters total limit in format 1 (all numeric) or format 2 (numeric “–“ two alpha) CR 42 characters total limit in format (two numeric “.” two numeric “.” etc) TK 8 to 12 characters in format 1 (all numeric) or format 2 (numeric “-“ three numeric) AC 42 characters, alphanumeric and some special characters AR 10 characters, alphanumeric X* 84 characters, alphanumeric and some special characters FT 84 characters, alphanumeric and some special characters
Example
{"ReservationDetail": {
"Receipt": [
{
"@type": "ReceiptConfirmation",
"Confirmation": {
"@type": "ConfirmationHold",
"ConfirmationStatus": "Confirmed",
"Locator": {
"locatorType": "Confirmation Number",
"source": "HL",
"sourceContext": "Supplier",
"value": "3262975466"
}
}
}
],
"Offer": [
{
"Product": [
{
"@type": "ProductHospitality",
"DateRange": {
"start": "2025-08-21",
"end": "2025-08-22"
}
}
]
}
]
}
}
Response
The Modify Hotel Reservation response is the same as the Create Reservation response, returning updated booking details. It returns all information on the booking, not just the updated details. See the Create Reservation API Reference for documentation.

{
"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": "Address",
"TextFormatted": [
{
"value": "5250 28Th Street Se Grand Rapids Mi 49512"
}
]
},
{
"@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."
}
]
},
{
"@type": "TextBlock",
"title": "Promotional",
"TextFormatted": [
{
"value": "Style And Space Beautifully Priced"
}
]
},
{
"@type": "TextBlock",
"title": "Guarantee",
"TextFormatted": [
{
"value": "ID Required Must Guarantee Late Arrival"
}
]
},
{
"@type": "TextBlock",
"title": "Cancellation",
"TextFormatted": [
{
"value": "cancel: 143.37 usd cancel fee person room cancellation permitted up to 1 days before arrival."
}
]
},
{
"@type": "TextBlock",
"title": "Other",
"TextFormatted": [
{
"value": "Available To AAA And Caa Members Only. Limit Of Two Rooms Person Member Person Night. Membership Card Required."
}
]
},
{
"@type": "TextBlock",
"title": "Room detail",
"TextFormatted": [
{
"value": "Maximum Occupancy- 5 Guests"
}
]
},
{
"@type": "TextBlock",
"title": "Fax",
"TextFormatted": [
{
"value": "1-616-464-1139"
}
]
},
{
"@type": "TextBlock",
"title": "Rate description",
"TextFormatted": [
{
"value": "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"
}
]
},
{
"@type": "TextBlock",
"title": "Rate amount",
"TextFormatted": [
{
"value": "12150 Person Night Starting 16 Oct For 1 Night"
}
]
},
{
"@type": "TextBlock",
"title": "Number Nights",
"TextFormatted": [
{
"value": "1"
}
]
},
{
"@type": "TextBlock",
"title": "Room rate",
"TextFormatted": [
{
"value": "Taxes - Total Tax/Surch/Fee - 21.87 P/Stay Taxes: 21.87 Usd Commissionable Rate"
}
]
},
{
"@type": "TextBlock",
"title": "Phone",
"TextFormatted": [
{
"value": "1-616-464-1130"
}
]
},
{
"@type": "TextBlock",
"title": "Total Amount",
"TextFormatted": [
{
"value": "14337 Approx Total Include All Known Taxes/Fees"
}
]
},
{
"@type": "TextBlock",
"title": "Room Hold Expiration Time",
"TextFormatted": [
{
"value": "BOOKING HELD UNTIL 00:00 LOCAL HOTEL TIME ON ARRIVAL DATE"
}
]
}
],
"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@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": "1028",
"CardCode": "VI",
"CardHolderName": "Sam Smith",
"CardNumber": {
"@type": "CardNumber",
"PlainText": "************0500"
}
}
}
],
"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": "7b10c69a-0721-4cc7-bede-eca387dd2908"
}
}
Additional Example
The following example request updates the credit card details used for the form of payment on an existing reservation.

{"ReservationDetail": {
"Receipt": [
{
"@type": "ReceiptConfirmation",
"Confirmation": {
"@type": "ConfirmationHold",
"ConfirmationStatus": "Confirmed",
"Locator": {
"locatorType": "Confirmation Number",
"source": "XV",
"sourceContext": "Supplier",
"value": "80073065"
}
}
}
],
"FormOfPayment": [
{
"@type": "FormOfPaymentPaymentCard",
"PaymentCard": {
"@type": "PaymentCard",
"expireDate": "1028",
"CardCode": "VI",
"CardType": "Credit",
"CardHolderName": "Sam Smith",
"CardNumber": {
"@type": "CardNumber",
"PlainText": "4305881219580500"
}
}
}
]
}
}