Modify Passive Reservation API Reference

ReservationDetail*

Top level object for the request.

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

---

Offer* if modifying any parameter in this group

Top level object for reservation details.

Includes Product, Price, and TermsAndConditionsFull objects.

---

Product* if modifying any parameter in this group

Details about the property, dates, and number of guests.

Includes PropertyAddress, GuestCounts, PropertyKey, and DateRange objects.

Quantity* if modifying the number of rooms : Number. The number of rooms requested; 1-9 inclusive supported. If not provided, default quantity is 1. Example: MK1

passiveBookingReasonCode* if modifying the /BC- parameter : String. Character representing the reason for creating a passive segment. Value is stored in /BC- parameter.

Supported values and meanings:

• 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

bookingCode* if modifying the /R- parameter : String. Booking code returned in the provider system. Value is stored in /R- parameter.

propertyName* if modifying the /N- parameter : String. Name of property. Value is stored in /N- parameter.

associatedCityCode : String. IATA city code associated with property. Default value: HDQ

---

PropertyAddress* if modifying the /W- parameter

Object for address details.

AddressLine* if modifying the /W- parameter : String. Street Address. Value is stored in the /W- parameter.

City* if modifying the /W- parameter : String. City where property is located. Value is stored in the /W- parameter.

StateProv : Object for State or Province.

value : String. State or Province code where property is located. Value is stored in the /W- parameter.

Country : Object for Country where property is located.

value : String. Country code where property is located. Value is stored in the /W- parameter.

PostalCode : String. Postal code where property is located. Value is stored in the /W- parameter.

guests* if modifying the /EX- parameter : String. Total number of guests. Numeric values 1-9 inclusive supported. Default is 1. Value is stored in the /EX- parameter.

---

 

GuestCounts* if modifying the /EC- parameter

Top level object.

Includes GuestCount object.

---

GuestCount* if modifying the /EC- parameter

Array of qualifying codes and ages.

count* if modifying the /EC- parameter: Integer. The number of guests in this instance of AgeQualifyingCode. If adult, value is stored in the /EX- parameter. If child, value is stored in the /EC- parameter.

ageQualifyingCode* if modifying the /EC- parameter: String. Required only for children or if traveler age is relevant, such as for a senior discount.

Supported values and meanings:

• 10: Traveler in this GuestCount is an adult

• 8: Traveler in this GuestCount is a child

age* if modifying the /EC- parameter: Integer. Age of traveler. Required only when request includes a child in room.

---

DateRange* if modifying the date range

Reservation date range.

start* if modifying the date range: String. Check-in date in YYYY-MM-DD format.

end* if modifying the date range: String. Check-out date in YYYY-MM-DD format.

---

PropertyKey* if modifying the property identification

Object for Travelport Property ID information.

chainCode: String. Two-character Travelport chain code to book.

propertyCode* if modifying the /P- parameter: String. Travelport property code of the property within the hotel chain. Value is stored in the /P- parameter.

---

Price* if modifying the /RQ- parameter.

Top level object for price information.

Includes CurrencyCode and PriceBreakdown objects.

TotalPrice* if modifying the /RQ- parameter: Number. Total price of room rate. Value is stored in the /RQ- parameter.

Base: Number. Base price of room rate.

---

CurrencyCode* if modifying the /RQ- parameter.

Top level object.

decimalPlace* if modifying the /RQ- parameter: Number. Number of decimal places for the currency code.

value* if modifying the /RQ- parameter: String. Three-character currency code for the offer returned in either the Availability or Rules response. Value is stored in the /RQ- parameter.

---

PriceBreakdown*if modifying the /CM- parameter

Object describing breakdown components of the rate price.

Includes Commission and Amount objects.

roomPricingType* if modifying the /CM- parameter: Describes the complete stay details. Accepted Value: Per stay

---

Commission* if modifying the /CM- parameter

Object describing commission type (Percent or Amount) and value.

Application* if modifying the /CM- parameter: Describes the presence of a commission. Accepted Value: Commissionable.

Percent: Integer. Percent value of commission. Value is stored in /CM- parameter.

---

Amount

Object describing the currency amount of the commission.

value: Integer. Amount of commission. Value is stored in /CM- parameter.

code: String. Currency code of commission.

---

TermsAndConditionsFull* if modifying the /CD- parameter

Object for the rules applied to this rate

Includes the ProductRateCodeInfo object.

---

ProductRateCodeInfo* if modifying the /CD- parameter

Object for describing a rate descriptor

Includes RateCodeInfo object.

---

RateCodeInfo* if modifying the /CD- parameter

Object for describing a rate code associated with this rate

rateID* if modifying the /CD- parameter: String. Used to represent a Corporate Discount number associated with this rate. Value is stored in /CD- parameter.

---

---

---

---

Example request body

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