Attention: Please check the Hotel Release Notes page for the latest updates and enhancements.

Modify Hotel Reservation API Reference

Put	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/

The Modify Reservation request can modify an existing reservation by changing any of the following: dates of reservation (if allowed by supplier, a change in price typically occurs.), payment information, name of the traveler associated to a reservation (given and/or surname), telephone number of the traveler associated to a reservation, or the email address of the traveler associated to a reservation. You can also add comments to an existing Travelport (not Booking.com or Expedia) reservation.

Modification of name is restricted to a matching name in the PNR. For instance, if the reservation is associated to name 1 of the PNR, the name modify can be used to change the reservation association to name 2 of the PNR.

Modify functionality by content source

Modifier	Travelport	Booking.com	Expedia
Traveler Name	Y	Y	Y
Traveler Telephone	Y	N	N
Traveler Email	Y	N	N
Credit Card	Y	Y	N
Date Change	Y	Y	N
Comments	Y	N	N

When changing dates for a reservation sold through Travelport, it is recommended that you first send an availability request for the new dates and look for the same booking code that is on the existing reservation. An availability request is not mandatory, but a modify request will fail if the new dates are not available.

Request

Also see Authorization and Common Hotel API Headers.

Query Parameters

None.

Request Body

Show Request Body Table

Object	Description	Required/Optional
ReservationDetail	Top level object for Modify Reservation request. Includes Traveler, Receipt, Offer, Form of Payment, and ReservationComment objects.	Required
Traveler	Traveler details. Includes PersonName, Telephone, Email, and CustomerLoyalty objects.	Required to modify traveler name or traveler telephone.
PersonName	Traveler name. The new name must match an existing name in the PNR. Travelport+ limits the combination of Given and Surname to 22 characters. Given name must have at least one character. PersonName exceeding 22 characters is truncated in the response.	Required to modify traveler name.
Given	String. Traveler first name, if changed.	Required to modify traveler name.
Surname	String. Traveler last name, if changed.	Required to modify traveler name.
Title	String. Traveler title.	Optional
Telephone	Traveler telephone details.	Required to modify traveler telephone.
phoneNumber	String. Phone number.	Required to modify traveler telephone.
areaCityCode	String. Phone local area code.	Required to modify traveler telephone.
countryAccessCode	String. Phone country code.	Optional
cityCode	String. Phone city code.	Optional
Email	Traveler email address.	Optional
value	String. Traveler email address.	Optional
CustomerLoyalty	One frequent guest number and / or one frequent flyer number.	Optional
programId	String. Two character hotel or air supplier code or brand code of the loyalty program.	Required if object used.
value	String. Number on loyalty card.	Required if object used.
supplierType	String. “hotel” for designating frequent guest or “air” for designating frequent flyer.	Required if object used.
Receipt	Top level object for confirmation details. Includes Confirmation object.	Required
Confirmation	Confirmation details. Includes ConfirmationStatus, Locator, and OfferStatus objects.	Required
ConfirmationStatus	Status of confirmation.	Required
Status	String. Status associated to the sold hotel segment. Send the value from the Create Reservation response: Receipt/Confirmation/ConfirmationStatus	Required
Locator	The supplier confirmation number. Send the value from the Create Reservation response: Receipt/Confirmation/ConfirmationStatus/Locator	Required
locatorType	String. Confirmation Number Send the value from the Create Reservation response Receipt/Confirmation/ConfirmationStatus/Locator/locatorType	Required
source	String. Content source. Supplier code. Send the value from the Create Reservation response Receipt/Confirmation/ConfirmationStatus/Locator/source	Required
sourceContext	String. Supplier. Send the value from the Create Reservation response Receipt/Confirmation/ConfirmationStatus/Locator/sourceContext	Required
value	String. The supplier confirmation number. Send the value from the Create Reservation response Receipt/Confirmation/ConfirmationStatus/Locator/value	Required
OfferStatus	Status of offer. Send the value from the Create Reservation response: Receipt/Confirmation/OfferStatus	Optional
Status	String. Status associated to the sold hotel segment. Send the value from the Create Reservation response: Receipt/Confirmation/OfferStatus/Status	Optional
Offer	Top level object used when changing reservation dates. Includes Identifier and Product objects.	Required only to change reservation dates.
Product	Details about the property, dates, and number of guests. Includes DateRange object.	Required only to change reservation dates.
DateRange	Check-in and -out dates.	Required only to change reservation dates.
start	String. Check-in date in YYYY-MM-DD format.	Required only to change reservation dates.
end	String. Check-out date in YYYY-MM-DD format.	Required only to change reservation dates.
specific	String. Same day check-in and -out date in YYYY-MM-DD format.	Optional
FormOfPayment	Required if modifying form of payment details. See table below.	Required only to modify payment information.

FormOfPayment object (send only if modifying FormOfPayment details)

Object	Description	Required/Optional
FormOfPayment	Top level object for form of payment details. Includes PaymentCard.	Required
PaymentCard	Form of payment details. Includes CardNumber, SeriesCode, Telephone, and Address objects.	Required
expireDate	String. Credit card expiration date in MMYY format.	Required
CardType	String. Type of card including Credit, Debit, and Gift.	Required
CardCode	String. Code for credit card type.	Required
CardHolderName	String. Name on credit card.	Required
CardNumber	Card number details.	Required
PlainText	String. Credit card number.	Required
SeriesCode	Security code of card.
PlainText	String. The credit card three- or four-digit CVV code. Booking.com and Expedia require the CVV code.	Required for certain suppliers.
Telephone	Telephone information associated with card.
countryAccessCode	String. Phone country code.	Optional
phoneNumber	String. Phone number.	Optional
areaCityCode	String. Phone local area code.	Optional
cityCode	String. Agency city code.	Optional
Address	Billing address details. Includes Number, Street, AddressLine, City, StateProv, Country, and PostalCode objects.	Optional
Number	Top level object for street number of billing address.	Optional
value	String. Street number value.	Optional
Street	String. See name value.	Optional
AddressLine	String. Address number and street name.	Optional
City	String. The city of the billing address.	Optional
County	String. The county of the billing address.	Optional
StateProv	Top level state or province object.	Optional
value	String. State or province of billing address.	Optional
name	String. Full state or province name.	Optional
Country	Country of billing address.	Optional
Value	String. Standard two-letter coded value for country.	Optional
Id	String. Custom user-assigned identifier for the country	Optional
Name	String. Full country name.	Optional
codeContext	String. Organization that provided the Id number.	Optional
PostalCode	String. Postal code of billing address.	Optional
Email	Billing email address.	Optional
value	String. Billing email address.	Optional

Optional objects - Comment

Types of remarks

Travelport Hotel Kit allows for the addition of these types of remarks on the Modify message:

Notepad remarks
1. General
2. Historical
3. Confidential
Unassociated remarks
Associated remarks
Special Instruction remarks
Accounting remarks

The Hotel Kit does not offer a method for updating (true modify or cancel) a remark item. A user must use the Workbench messages to update any existing remark items.

Object

Description

Required/Optional

ReservationComment

Optional top level object used for notepad, unassociated, and special instruction remarks.

Includes Comment and Applies To object.

Optional

commentSource

Originator of comment. Accepted value: Agency.

Required

shareWith

Designates visibility of remark.

Notepad remarks: Agency

Unassociated remarks: Traveler

Associated remarks: Traveler

Special instructions: Supplier

Required

Comment

Array of name/value pairs.

Required

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

Required

value

String. Remark text. Limits:

Notepad remarks: 87 characters

Unassociated remarks: 70 characters

Associated remarks: 70 characters

Special instruction remarks: 50 characters

Required

AppliesTo

Only used with associated remarks. Top level object to designate which hotel segments to link a remark.

Required for associated remarks.

OfferIdentifier

Object for hotel segment offer number.

Required for associated remarks.

offerRef

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.

Required for associated remarks.

Accounting

Optional top level object used for all DOCI remarks.

Includes NameValuePair object.

Optional

dataType

Accounting remark designator. Accepted value: DOCI.

Required

NameValuePair

Array of name/value pairs.

Required

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

Required

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

Required

Response

The response to the Modify Reservation request returns the updated information using the same structure as the response to Create Reservation.

Example Request

The following example request modifies the form of payment and adds a comment.

Show Example Request


{
  "ReservationDetail": {
    "Receipt": [
      {
        "@type": "ReceiptConfirmation",
        "Confirmation": {
          "@type": "ConfirmationHold",
          "ConfirmationStatus": "Confirmed",
          "Locator": {
            "locatorType": "Confirmation Number",
            "sourceContext": "Supplier",
            "value": "97037700"
          }
        }
      }
    ],
    "FormOfPayment": [
      {
        "@type": "FormOfPaymentPaymentCard",
        "PaymentCard": {
          "@type": "PaymentCardDetail",
          "expireDate": "0627",
          "CardType": "Credit",
          "CardCode": "VI",
          "CardHolderName": "Frank Sinatra",
          "CardNumber": {
            "@type": "CardNumber",
            "PlainText": "4539231979020313"
          },
          "SeriesCode": {
            "@type": "SeriesCode",
            "PlainText": "647"
          },
          "PersonName": {
            "@type": "PersonNameDetail",
            "Given": "Sridhar",
            "Middle": "Example String Value",
            "Surname": "Vudutha"
          },
          "Address": {
            "@type": "AddressDetail",
            "Number": {
              "value": "125"
            },
            "Street": "Billing Address Street",
            "AddressLine": [
              "125 Billing Address Street"
            ],
            "City": "Claremont",
            "County": "Los Angeles",
            "StateProv": {
              "value": "CA",
              "name": "Texas"
            },
            "Country": {
              "value": "US",
              "id": "country_4",
              "name": "United States",
              "codeContext": "Example String Value"
            },
            "PostalCode": "91711-3323"
          },
          "Telephone": [
            {
              "@type": "TelephoneDetail",
              "countryAccessCode": "1",
              "areaCityCode": "909",
              "phoneNumber": "1231234",
              "cityCode": "DEN"
            }
          ],
          "Email": [
            {
              "value": "smith@example.com"
            }
          ]
        }
      }
    ]
  }
}

Example Response

Show Example Response


{
  "ReservationResponse": {
    "Reservation": {
      "@type": "ReservationDetail",
      "id": "7122e5bc-591d-468d-b5ec-85ee1951f486",
      "Offer": [
        {
          "@type": "Offer",
          "id": "O1",
          "Identifier": {
            "authority": "TVPT"
          },
          "Product": [
            {
              "@type": "ProductHospitality",
              "Quantity": 1,
              "bookingCode": "XMIA00",
              "guests": 1,
              "PropertyKey": {
                "chainCode": "SI",
                "propertyCode": "73851"
              },
              "DateRange": {
                "start": "2022-09-11",
                "end": "2022-09-12"
              }
            }
          ],
          "Price": {
            "@type": "PriceDetail",
            "CurrencyCode": {
              "value": "GBP",
              "decimalPlace": 2
            },
            "TotalPrice": 399.2
          },
          "TermsAndConditionsFull": [
            {
              "@type": "TermsAndConditionsFullHospitality",
              "CancelPenalty": [
                {
                  "Deadline": {
                    "SpecificDate": {
                      "specific": "2022-09-10"
                    },
                    "Time": "07:25:00"
                  },
                  "Refundable": "Yes"
                }
              ]
            }
          ]
        }
      ],
      "Traveler": [
        {
          "@type": "Traveler",
          "id": "T1",
          "PersonName": {
            "@type": "PersonName",
            "Given": "AAAG",
            "Surname": "AAAAS"
          },
          "Telephone": [
            {
              "@type": "Telephone",
              "phoneNumber": "011-111111111",
              "cityCode": "DEN"
            },
            {
              "@type": "Telephone",
              "phoneNumber": "022-22222222",
              "cityCode": "DEN"
            },
            {
              "@type": "Telephone",
              "phoneNumber": "033-333333333",
              "cityCode": "DEN"
            }
          ],
          "Email": [
            {
              "value": "aaa@travelport.com"
            }
          ]
        }
      ],
      "TravelerProduct": [
        {
          "@type": "TravelerProduct",
          "TravelerRef": "T1",
          "OfferRef": "O1"
        }
      ],
      "Receipt": [
        {
          "@type": "ReceiptConfirmation",
          "OfferRef": [
            "O1"
          ],
          "Confirmation": {
            "@type": "ConfirmationHold",
            "Locator": {
              "value": "97037700",
              "locatorType": "Confirmation Number",
              "source": "SI",
              "sourceContext": "Supplier"
            },
            "OfferStatus": {
              "@type": "OfferStatusHospitality",
              "Status": "Confirmed"
            }
          }
        },
        {
          "@type": "ReceiptConfirmation",
          "Confirmation": {
            "@type": "ConfirmationHold",
            "Locator": {
              "value": "2BPK1S",
              "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"
                }
              ]
            }
          ]
        }
      ]
    }
  }
}

Error Messages

Error messages for Hotel Modify Existing API.

Show Error Messages

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 Modify request: Invalid confirmation number.
	400	INVALID - CREDIT CARD
	400	UNSUCCESSFUL LINK SELL- MSG FROM LINK VENDOR INVALID FORM OF GUARANTEE
	400	UNSUCCESSFUL LINK SELL- MSG FROM LINK VENDOR INVALID CREDIT CARD VENDOR ID
	400	First Name and Last Name required for modify.
	400	INVALID - DATE MODIFICATION
	400	Cannot parse 05-03: Text '05-03' could not be parsed at index 0. Date format must be yyyy-MM-dd.
	400	INVALID-ARRIVAL DATE IN THE PAST
	400	ARRIVAL DATE BEYOND 331 DAYS INTO FUTURE
	400	INVALID-OUT DATE IN THE PAST
	400	CHECK OUT DATE BEYOND 332 DAYS INTO FUTURE
	401	Unathorised user.
	500	null