Check the Hotel Release Notes for updates across all Hotel APIs.

Modify Passive Reservation API Reference

Put

book/reservations/{reservationIdentifier}/passiveupdate

Base path:

Use this base path if you have not yet received or not migrated to the new credentials from Travelport:

Pre-production https://api.pp.travelport.com/11/hotel/

Production https://api.travelport.com/11/hotel/

Use this base path after you have migrated to the new credentials from Travelport (using .net instead of .com):

Pre-production https://api.pp.travelport.net/11/hotel/

Production https://api.travelport.net/11/hotel/

Use Modify Passive Reservation to modify any parameter within an MK passive hotel booking segment of an existing PNR. This is a full payload request that results in a single HTL MK segment in the PNR constructed from the components of the request. There is no reference payload version of this request.

Request

Also see Authentication and Common Hotel API Headers.

Query Parameters

None.

Request Body

Show Request Body Table

The tables in this section break down the Create Reservation request into its top level objects to separate the information in each.

Object	Description	Required/Optional
ReservationDetail	Top level object for the request. Includes the Offer, Traveler, FormOfPayment, Payment, Receipt, and ReservationComment objects.	Required

Object

Description

Required/Optional

ReservationDetail

Top level object for the request.

Includes the Offer, Traveler, FormOfPayment, Payment, Receipt, and ReservationComment objects.

Required

Offer object

Object	Description	Required/Optional
Offer	Top level object for reservation details. Includes Product, Price, and TermsAndConditionsFull objects.	Required if modifying any parameter in this group.
Product	Details about the property, dates, and number of guests. Includes PropertyAddress, GuestCounts, PropertyKey, and DateRange objects.	Required if modifying any parameter in this group.
Quantity	Number. The number of rooms requested; 1-9 inclusive supported. If not provided, default quantity is 1. Example: MK1	Required if modifying the number of rooms.
passiveBookingReasonCode	String. Character representing the reason for creating a passive segment. Value will be stored in /BC- parameter. Codeset: G – Group booking H – Property not listed I – Internet only rate N – Multi-level rate not offered (negotiated/corporate rate) P – Package or Tour rate not offered R – Rate not offered U – Property sold out V – Government rate not offered	Required if modifying the /BC- parameter.
bookingCode	String. Booking code returned in the provider system. Value will be stored in /R- parameter.	Required if modifying the /R- parameter.
propertyName	String. Name of property. Value will be stored in /N- parameter	Required if modifying the /N- parameter.
associatedCityCode	String. IATA city code associated with property. Default value: HDQ	Optional
PropertyAddress	Object for address details.	Required if modifying the /W- parameter.
AddressLine	String. Street Address. Value will be stored in the /W- parameter	Required if modifying the /W- parameter.
City	String. City where property is located. Value will be stored in the /W- parameter	Required if modifying the /W- parameter.
StateProv	Object for State or Province.	Optional
value	String. State or Province code where property is located. Value will be stored in the /W- parameter.	Optional
Country	Object for Country where property is located.	Optional
value	String. Country code where property is located. Value will be stored in the /W- parameter.	Optional
PostalCode	String. Postal code where property is located. Value will be stored in the /W- parameter.	Optional
guests	String. Total number of guests. Numeric values 1-9 inclusive supported. Default is 1. Value will be stored in the /EX- parameter.	Required if modifying the /EX- parameter.
GuestCounts	Top level object. Includes GuestCount object.	Required if modifying the /EC- parameter.
GuestCount	Array of qualifying codes and ages.	Required if modifying the /EC- parameter.
count	Integer. The number of guests in one AgeQualifyingCode. If adult, value will be stored in the /EX- parameter. If child, value will be stored in the /EC- parameter.	Required if modifying the /EC- parameter.
ageQualifyingCode	String. Required only if traveler age is relevant to a code. Adult code: 10 Child code: 8	Required if modifying the /EC- parameter.
age	String. Age of traveler. Required only when request includes a child in room.	Required if modifying the /EC- parameter.
DateRange	Reservation date range.	Required if modifying the date range.
start	String. Check-in date in YYYY-MM-DD format.	Required if modifying the date range.
end	String. Check-out date in YYYY-MM-DD format.	Required if modifying the date range.
PropertyKey	Object for Travelport Property ID information.	Required if modifying the property identification.
chainCode	String. Two-character Travelport chain code to book.	Optional
propertyCode	String. Travelport property code of the property within the hotel chain. Value will be stored in the /P- parameter.	Required if modifying the /P- parameter.
Price	Top level object for price information. Includes CurrencyCode and PriceBreakdown objects.	Required if modifying the /RQ- parameter.
TotalPrice	Number. Total price of room rate. Value will be stored in the /RQ- parameter	Required if modifying the /RQ- parameter.
Base	Number. Base price of room rate.	Optional
CurrencyCode	Top level object.	Required if modifying the /RQ- parameter.
decimalPlace	Number. Number of decimal places for the currency code.	Required if modifying the /RQ- parameter.
value	String. Three-character currency code for the offer returned in either the Availability or Rules response. Value will be stored in the /RQ- parameter.	Required if modifying the /RQ- parameter.
PriceBreakdown	Object describing breakdown components of the rate price. Includes Commission and Amount objects.	Required if modifying the /CM- parameter.
roomPricingType	Describes the complete stay details. Accepted Value: Per stay	Required if modifying the /CM- parameter.
Commission	Object describing commission type (Percent or Amount) and value.	Required if modifying the /CM- parameter.
Application	Describes the presence of a commission. Accepted Value: Commissionable.	Required if modifying the /CM- parameter.
Percent	Integer. Percent value of commission. Value will be stored in /CM- parameter.	Optional
Amount	Object describing the currency amount of the commission.	Optional
value	Integer. Amount of commission. Value will be stored in /CM- parameter.	Optional
code	String. Currency code of commission.	Optional
TermsAndConditionsFull	Object for the rules applied to this rate Includes the ProductRateCodeInfo object.	Required if modifying the /CD- parameter.
ProductRateCodeInfo	Object for describing a rate descriptor Includes RateCodeInfo object.	Required if modifying the /CD- parameter.
RateCodeInfo	Object for describing a rate code associated with this rate	Required if modifying the /CD- parameter.
rateID	String. Used to represent a Corporate Discount number associated with this rate. Value will be stored in /CD- parameter.	Required if modifying the /CD- parameter.

FormOfPayment object

Object	Description	Required/Optional
FormOfPayment	Top level object for form of payment details. Includes PaymentCard object.	Optional
PaymentCard	Form of payment details. Includes CardNumber and SeriesCode objects. Values will be stored in the /G- parameter.	Required if modifying the form of payment (/G- or /D-) parameter.
expireDate	String. Credit card expiration date in MMYY format.	Required if modifying the form of payment (/G- or /D-) parameter.
CardType	String. Type of card including Credit, Debit, and Gift.	Optional
CardCode	String. Code for credit card type.	Required if modifying the form of payment (/G- or /D-) parameter.
CardHolderName	String. Name on credit card.	Optional
CardNumber	Card number details.	Required if modifying the form of payment (/G- or /D-) parameter.
PlainText	String. Credit card number.	Required if modifying the form of payment (/G- or /D-) parameter.
SeriesCode	Security code of card.	Optional
PlainText	String. The credit card three- or four-digit CVV code.	Optional

Payment object

Object	Description	Required/Optional
Payment	Top level object for payment details. The payment object is used to explicitly denote the amount expected to be charged for the hotel reservation in this style: For Prepay Required rates, the full total amount is used. This amount will be charged to the credit card on this transaction. Indicators should be set as: depositInd = true; guaranteeInd = false. For Deposit Required rates, the deposit amount is used. This amount will be charged to the credit card on this transaction. Indicators should be set as: depositInd = true; guaranteeInd = false. For Guarantee Required rates, the full total amount is used. This amount is expected to be charged to the credit card at check in. Indicators should be set as: depositInd = false; guaranteeInd = true. Includes Amount object.	Required if modifying the form of payment (/G- or /D-) parameter.
id	String. Customer-assigned identifier for the payment.	Optional
PaymentRef	String. Customer-assigned name for the payment.	Optional
depositInd	Boolean (true/false). If set to true, form of payment will be stored in /D- field.	Required if modifying the form of payment (/G- or /D-) parameter.
guaranteeInd	Boolean (true/false). If set to true, form of payment will be stored in the /G- field.	Required if modifying the form of payment (/G- or /D-) parameter.
Amount	Amount of payment.	Optional
code	String. Currency code.	Optional
value	Decimal number. Amount to pay.	Optional

Receipt object

Object	Description	Required/Optional
Receipt	Top level object for confirmation details. Includes Confirmation object.	Required
Confirmation	Confirmation details. Includes ConfirmationStatus and Locator objects	Required
ConfirmationStatus	Status of confirmation.	Optional
Status	String. Status associated to the sold hotel segment. Accepted value: Confirmed	Optional
Locator	The supplier confirmation number.	Required
locatorType	String. Accepted value: Confirmation Number.	Required
source	String. Content source. Supplier chain code.	Optional
sourceContext	String. Accepted value: Supplier.	Required
value	String. The supplier confirmation number from the booking system.	Required

Optional objects - Comment

Object	Description	Required/Optional
ReservationComment	Optional top level object used for special instruction remarks. Values will be stored in the /SI- parameter. Includes Comment object.	Optional
commentSource	String. Originator of comment. Accepted value: Agency.	Required if modifying the /SI- parameter.
shareWith	String. Designates visibility of remark. Special instructions: Supplier	Required if modifying the /SI- parameter.
Comment	Array of name/value pairs.	Required if modifying the /SI- parameter.
name	String. Type of remark. Special instruction remarks: SI	Required if modifying the /SI- parameter.
value	String. Remark text. Limits: Special instruction remarks: 50 characters	Required if modifying the /SI- parameter.

Response

The response for the Modify Passive Reservation Full Payload request is nearly identical to the response for the create reference payload request.

See the Create Reservation Reference Payload API Reference for the response table and examples.

Example Request

The example below shows the Modify Passive Reservation full payload request to modify the stay dates of the segment:

HTL HL MK1 DEN 10NOV-OUT15NOV /P-12345/N-HILTON DOWNTOWN DENVER/RQ-USD256.00/R-ABC123/CF-12344DJSH/W-123 Main Street*Denver*CO*US*65445/BC-H/SI-Remark/NM-FIRST LAST/CD-12345678/G-VI1234123412341234EXP1026/CM-10/EX-2/EC-1

Show Example Request

{
    "ReservationDetail": {
        "Offer": [
            {
                "@type": "Offer",
                "Product": [
                    {
                        "@type": "ProductHospitality",
                        "DateRange": { //modify the stay dates
                            "start": "2025-11-10",
                            "end": "2025-11-15"
                        }
                    }
                ]
            }
        ],
        "Receipt": [
            {
                "@type": "ReceiptConfirmation",
                "Confirmation": {
                    "@type": "ConfirmationHold",
                    "confirmationStatus": {
                        "@type": "OfferStatusHospitality",
                        "Status": "Confirmed"
                    },
                    "Locator": {
                        "value": "12344DJSH ", //mandatory
                        "locatorType": "Confirmation Number",
                        "source": "HL",
                        "sourceContext": "Supplier"
                    }
                }
            }
        ]
    }
}

Example Response

The response for the Modify Passive Reservation Full Payload request is identical to the response for the Create Passive Reservation Full Payload request and can be found here: Create Passive Reservation Reference Payload API Reference.

Error Messages

These error messages are specific to all Passive Reservation Full Payload type messages.

Show Error Messages

SourceCode	Message	StatusCode (HTTP code)
13090	PASSIVE BOOKING REASON CODE IS MISSING OR INVALID	400
13091	PASSIVE OFFER MUST CONTAIN PROPERTY ID OR COMBINATION OF HOTEL NAME AND ADDRESS	400

See the Create Reservation Reference Payload API Reference for general Create Reservation error messages.