Modify Hotel Reservation v9 API Reference

Put

reservation/v9/reservations/{reservation}

For {LocatorCode} send the locator code of the reservation to retrieve (returned in the reservation commit in Confirmation/Locator/value).

Base path:

Pre-production https://api.apim-a.adc.pp.travelport.io/hotel/

Production https://api.apim-a.adc.prod.travelport.io/hotel/

Related Content: Hotel Guide, Hotel Workflow Diagram

Modify an existing reservation by changing any of the following: dates, payment information, traveler first and/or last name.

Request

Also see Authorization and Common Hotel API Headers.

Query Parameters

None.

Request Body

Show Request Body Table

Object	Description	Required/Optional
ReservationBackOffice	Top-level object for Modify Reservation request. Includes Traveler, Receipt, Offer, Form of Payment, Payment, and ReservationComment, TravelAgency, and BackOffice objects.	Required
id	String. A system provided tracking ID. The response reflects this tracking ID.	Required
Traveler	Traveler details. Includes PersonName object.	Required only to modify traveler name.
PersonName	Traveler name.	Required only to modify traveler name.
Given	String. Traveler first name, if changed.	Required only to modify traveler name.
Surname	String. Traveler last name, if changed.	Required only to modify traveler name.
Receipt	Confirmation details. Includes Confirmation object.	Required
Confirmation	Confirmation details. Includes Locator object.	Required
ConfirmationStatus	String. Status of confirmation. Possible values: Cancelled Confirmed Pending Rejected	Required
Locator	The reservation locator code.	Required
source	String. Content source. Either two-digit GDS or Supplier code.	Required
sourceContext	String. Either Travelport or Supplier.	Required
value	String. Reservation locator code. If sourceContext is Travelport, the value is the reservation locator code. If sourceContext is Supplier, the value is the supplier confirmation number.	Required
Offer	Details of reservation. Includes Product object.	Required only to change reservation dates.
Product	Specifics about the reservation. 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.
FormOfPayment Required only to modify payment information.	Form of payment details. Includes PaymentCard object.	Required only to modify payment information.
PaymentCard Required only to modify payment information.	Payment card details. Includes CardNumber object.	Required only to modify payment information.
expireDate	String. Credit card expiration date in MMYY format.	Required only to modify payment information.
CardType	String. Type of card.	Required only to modify payment information.
CardCode	String. Code for credit card type.	Required only to modify payment information.
CardHolderName	String. Name on credit card.	Required only to modify payment information.
CardNumber	Credit card number.	Required only to modify payment information.
PlainText	String. Credit card number.	Required only to modify payment information.
ReservationComment	Includes Comment object.	Optional
Comment	Any comments about the reservation to add special instructions. Multiple Comment objects may be sent.	Optional
value	String. Text sent to supplier for special instructions. Limit of 50 characters.	Optional

Response

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

Example Request

The following example request modifies only the payment information and adds a comment to an existing hotel reservation.

Show Example Request

Payment change

{
  "ReservationBackOffice": {
    "id": "reservation_1",
    "Receipt": [
      {
        "@type": "ReceiptConfirmation",
        "Confirmation": {
          "@type": "ConfirmationHold",
          "ConfirmationStatus": "Confirmed",
          "Locator": {
            "sourceContext": "Travelport",
            "value": "34V0ZM"
          }
        }
      },
      {
        "@type": "ReceiptConfirmation",
        "Confirmation": {
          "@type": "ConfirmationHold",
          "ConfirmationStatus": "Confirmed",
          "Locator": {
            "source": "HY",
            "sourceContext": "Supplier",
            "value": "HY0041930627"
          }
        }
      }
    ],
    "FormOfPayment": [
      {
        "@type": "FormOfPaymentPaymentCard",
        "PaymentCard": {
          "@type": "PaymentCardDetail",
          "expireDate": "1122",
          "CardType": "Credit",
          "CardCode": "VI",
          "CardHolderName": "FRANK SINATRA",
          "CardNumber": {
            "PlainText": "4444333322221111"
          }
        }
      }
    ],
    "ReservationComment": [
      {
        "@type": "ReservationComment",
        "Comment": [
          {
            "value": "xxxExample String Value",
            "id": "comment_8",
            "name": "Example String Value",
            "language": "EN"
          }
        ]
      }
    ]
  }
}

Example Response

Show Example Response

Response for payment change.

{
  "ReservationResponse": {
    "Reservation": {
      "@type": "ReservationBackOffice",
      "id": "53c36af0-65c9-4a33-b506-78940fc99222:npn",
      "Offer": [
        {
          "@type": "Offer",
          "Product": [
            {
              "@type": "ProductHospitality",
              "bookingCode": "1KNRACK",
              "guests": 1,
              "Quantity": "1",
              "PropertyKey": {
                "chainCode": "HY",
                "propertyCode": "81388"
              },
              "DateRange": {
                "start": "2020-04-12",
                "end": "2020-04-13"
              }
            }
          ],
          "Price": {
            "@type": "PriceDetail",
            "currencyCode": "USD",
            "TotalPrice": "197.35"
          },
          "TermsAndConditionsFull": [
            {
              "@type": "TermsAndConditionsFullHospitality",
              "Description": [
                "CXL:CANCEL BY 3PM MST 48 HOURS PRIOR TO ARRIVAL *"
              ]
            }
          ]
        }
      ],
      "Traveler": [
        {
          "@type": "Traveler",
          "PersonName": {
            "@type": "PersonName",
            "Given": "JANE",
            "Surname": "DOE"
          }
        }
      ],
      "Receipt": [
        {
          "@type": "ReceiptConfirmation",
          "Confirmation": {
            "@type": "ConfirmationHold",
            "ConfirmationStatus": "Confirmed",
            "Locator": {
              "sourceContext": "Travelport",
              "value": "34V0ZM"
            }
          }
        },
        {
          "@type": "ReceiptConfirmation",
          "Confirmation": {
            "@type": "ConfirmationHold",
            "ConfirmationStatus": "Confirmed",
            "Locator": {
              "source": "HY",
              "sourceContext": "Supplier",
              "value": "HY0041930627"
            }
          }
        }
      ],
      "ReservationComment": [
        {
          "@type": "ReservationComment",
          "Comment": [
            {
              "value": "xxxExample String Value"
            }
          ]
        }
      ]
    }
  }
}

Error Messages

None.