Hotel Release Notes

The following model changes were made with this release.

Search request

• rateCategory: allows user to request categorical rates be considered in search

  Code snippet

  "RateCandidates": {
      "RateCandidate": [
          {
              "rateCategory": "Promotional"
          },
          {
              "rateCategory": "Government"
          }
      ]
  }
  

• AggregatorList: restrict search to specific aggregator

  Code snippet

  "AggregatorList": {TVPT},

Search response

• PropertyAmenity: Property level amenity descriptions and codes

  Code snippet

  "PropertyAmenity": [
      {
          "description": "Parking",
          "code": 68
      },
  

The following model changes were made with this release.

Search request

• availablePropertiesInd: allows user to request only properties with available rooms be returned in the response

• brand code: Brand code support introduced

• Code snippet

  "returnOnlyAvailablePropertiesInd": true,

  "ChainCodes": "EH",

Search response

No change

The following model changes were made with this release.

Search request

• SearchByCity: search type used to specifically use a three letter IATA city code

• SearchCity: Three letter IATA city code to use as center point for search

  Code snippet

  "SearchBy": {
                           "@type": "SearchByCity",  - NEW 
                          "SearchRadius": {
                                "value": 25,
                                "unitOfDistance": "Miles"
                           },
                         "SearchCity": "PAR"   - NEW 
                  }
  

Search response

No change

The following model changes were made with this release.

Search request

• returnAllImagesInd: Element to distinguish between requesting one or all images for each property returned in the response. Boolean values of true/false. Default when missing in request is false.

• ImageSize: Added new size of ExtraLarge.

  Code snippet

  "PropertiesQuerySearch": {
      "CheckInDate": "2021-04-01",
      "CheckOutDate": "2021-04-04",
      "returnAllImagesInd": false,
      "ImageSize": "ExtraLarge",
  

Search response

• Image: Object describing parameters of an image.

  • dimensionCategory: Added new size of ExtraLarge

    Code snippet

                "Image": [
                 {
                    "dimensionCategory": "E",
                    "caption": "The all new Staybridge Suites Denver Downtown-Actu",
                    "pictureCategory": 1,
                    "value": https://travelport.leonardocontentcloud.com/imageRepo/5/0/91/808/883/DENCA_4732251338_I.jpg
                  }
                ],
    

The following model changes were made with this release.

Search request

• No changes

Search response

• MaximumAvailableRate: Object describing highest rate returned for a property

  • code: Code for the currency the rate is returned in.

  • value: Amount of maximum available rate.

  • authority: Indicates which supplier returned the maximum available rate for that property. Supported values are:

    • TVPT: Travelport

    • EXPE: Expedia

    • BKNG: Booking.com

The following model changes were made with this release.

Search request

• RateCandidates (top level object to request negotiated rate codes and/or loyalty number be applied to search)

  • RateCandidate (secondary level object)

    • rateCode (array of negotiated rate codes)

    • CustomerLoyalty (object used when requesting loyalty number)

      • supplier (hotel supplier code or brand code)

      • value (loyalty number)

Search response

• PropertyInfo

  • availability (Element describing the returned lowest rate.)

    • Open: Property has rooms/rates available that match search parameters.

    • Other: Property has rooms/rates available that do not match search parameters.

    • Close: Property has no rooms available.

The following model changes were made with this release.

Search request

• No changes

Search response

• PropertyInfo

  • Identifier (New object to identify source of lowest rate. Will not be returned if property is closed or returns an error.)

    • authority (TVPT = Travelport; EXPE = Expedia; BKNG = Booking.com)

The following model changes were made with this update.

Details request

• No changes

Details response

• Attraction: Array of attractions near property.

  • name: Name of attraction.

  • Distance: Object defining distance from property

    • value: numeric distance

    • unitOfDistance: kilometers or miles

• CheckInOutPolicy

  • checkInTime: Check in time of property

  • checkOutTime: Check out time of property

  • minimumAge: Minimum age to reserve room

  • Description: Array of text information related to Check In / Out Policy

    • value: free text

  Code snippet

  "Attraction": [
                              {
                                  "name": "Beppu Tower",
                                  "Distance": {
                                      "value": 0.4,
                                      "unitOfDistance": "Kilometers"
                                  }
                              },
                              {
                                  "name": "Takegawara Onsen",
                                  "Distance": {
                                      "value": 0.4,
                                      "unitOfDistance": "Kilometers"
                                  }
                              }
                          ],
                          "CheckInOutPolicy": {
                              "checkInTime": "3:00 PM",
                              "checkOutTime": "11:00 AM",
                              "minimumAge": 18,
                              "Description": [
                                  {
                                      "value": "Extra-person charges may apply and vary depending on property policy"
                                  },
                                  {
                                      "value": "Government-issued photo identification and a credit card, debit card, or cash deposit may be required at check-in for incidental charges"
                                  },
                                  {
                                      "value": "Special requests are subject to availability upon check-in and may incur additional charges; special requests cannot be guaranteed"
                                  },
                                  {
                                      "value": "This property accepts credit cards and cash"
                                  },
                                  {
                                      "value": "Please note that cultural norms and guest policies may differ by country and by property; the policies listed are provided by the property"
                                  }
                              ]
                          }
  

The following model changes were made with this update.

Details request

• No changes

Details response

• PropertyAmenity: Array of amenities provided at property.

  • description: Type of amenity in text.

  • code: OTA code for amenity

    Code snippet

    "PropertyAmenity": [
                                {
                                    "description": "High speed internet access",
                                    "code": "259"
                                },
                                                     ],
    

The following model changes were made with this upgrade.

Details request

• Truncated GET message to the following format, removing check-in date, check-out date, and number of guests:

https://api.pp.travelport.com/11/hotel/search/propertiesdetail?chainCode={XX{&propertyCode={123AB}

Details response

• No changes

The following model changes were made with this release.

Availability request

• rateCategory All: support of the All category

  Code snippet

  "RateCandidates": {
      "RateCandidate": [
          {
              "rateCategory": "All"
          },
      ]
  }
  

• AggregatorList: restrict availability to specific aggregator

  Code snippet

  "AggregatorList": {TVPT},

Availability response

• Address: property address included with verbose = false

  Code snippet

  "Address": {
                                                            ”type": "Address",
                                                            "AddressLine": [
                                                            "9280 East Costilla Avenue"
                                                            ],
                                                            "City": "ENGLEWOOD",
                                                            "StateProv": {
                                                            "value": "CO"
                                                            },
                                                            "Country": {
                                                            "name": "United States",
                                                            "value": "US"
                                                            },
                                                            "PostalCode": "80112     "
                                                            },
  

• GeoLocation: property geocode included with verbose = false

  Code snippet

  "GeoLocation": {
                "latitude": "39.735297",
                "longitude": "-104.98741"
              },
  

The following model changes were made with this update.

Availability request

• Added Customer Loyalty card capability

  Code snippet

  "CustomerLoyalty": [
     {
      "supplier": "XX",
      "value": "123ABC"
     }
  ]
  

Availability response

• None

The following model changes were made with this update.

Availability request

• None

Availability response

• Error – Array of error information related to this transaction.

  • Message – Error information text normally displayed to end user.

  • NameValuePair – Array with specific information related to the aggregator returned error for a property.

    • name – Description of type of information (ChainCode, PropertyCode, MessageDetail) Multiple MessageDetail occurrences will be returned for differing descriptions per aggregator for this property.

    • value – Information text.

  • StatusCode – error code normally displayed to end user.

  Code snippet

  "CatalogOfferingsHospitalityResponse": {
          "@type": "CatalogOfferingsHospitalityResponse",
          "Result": {
              "@type": "Result",
              "Error": [
                  {
                      "@type": "ErrorDetail",
                      "Message": "No Room Stays/Rate Plans received from any provider",
                      "NameValuePair": [
                          {
                              "name": "ChainCode",
                              "value": "PT"
                          },
                          {
                              "name": "PropertyCode",
                              "value": "E5355"
                          },
                          {
                              "name": "MessageDetail",
                              "value": "No Room Stays/Rate Plans received from the provider"
                          },
                          {
                              "name": "MessageDetail",
                              "value": "Hotel requested not available"
                          }
                      ],
                      "StatusCode": 404
                  }
              ]
          },
  

The following model changes were made with this release.

Availability request

• None

Availability response

• Added adaCompliant and propertyName fields in Product object when verbose = true.

• Added availability and propertyName fields in ReferenceList.PropertyDates object when verbose = false.

The following model changes were made with this upgrade.

Availability request

• None

Availability response

• Added code and includedIndicator fields in RoomAmenity object.

• Used array feature of CancelPenalty to return two instances of information: one relating to refundable time period; one relating to non-refundable time period when the information is returned by the supplier.

The following model changes were made with this release.

Availability request

• None

Availability response

• Added purpose field in Tax object.

• When returned, Commission and Description (rate description) display in the Price.PriceBreakdown.roomPricingType = Per stay section.

• When returned, AverageNightlyRate displays in the Price.PriceBreakdown.roomPricingType = Per night section.

The following model changes were made with this upgrade.

Availability request

• New structure for Rate Code information.

Availability response

• Added authority field.

• Changed currencyCode to CurrencyCode.

• All amount values are no longer enclosed with quotation marks.

• All true/false values are no longer enclosed with quotation marks.

• Improved Room Description and Rate Description fields.

• New structure for Rate Code information, Commission, and Cancel Penalty.

• Each offer returns a unique identifier value that can be sent instead of full offer details in a subsequent reference payload request for either Rules or Create Reservation.

The following model changes were made with this release.

Rules request

• None

Rules Full and Reference Payload response

• Added TextBlock title Room Hold Expiration Time.

• Added Date in Deposit object.

Rules Reference Payload response

• Added code and includedIndicator fields in RoomAmenity object.

The following model changes were made with this release.

Rules request

• None

Rules by Offer ID response

• Added purpose field in Tax object.

• When returned, Commission and Description (rate description) display in the Price.PriceBreakdown.roomPricingType = Per stay section.

• When returned, AverageNightlyRate displays in the Price.PriceBreakdown.roomPricingType = Per night section.

The following model changes were made with this upgrade.

Rules request

• Added HotelAggregator in full payload request.

• New structure for rate code information.

• New reference payload request.

Rules response

• Added authority object.

• Changed currencyCode to CurrencyCode.

• All amount values are no longer enclosed with quotation marks.

• All true/false values are no longer enclosed with quotation marks.

• Improved RoomDescription and RateDescription objects.

• New structure for information on rate codes, commissions, bed configuration, meals, and cancel penalties.

The following model changes were made with this release.

Create Reservation Reference Payload / Full Payload request

• Reservation comments / Accounting, Notepad, Unassociated (see snippet)

  Code snippet

  "Accounting": {
              "@type": "Accounting", // this covers the accounting remark type
              "dataType": "DOCI",
              "NameValuePair": [
                  {
                      "name": "AC",
                      "value": "A53.IBM213.JAMES"
                  },
                  {
                      "name": "TK",
                      "value": "2040805184"
                  },
                  {
                      "name": "FT",
                      "value": "offerNumber.PTR 41641463345"
                  },
                  {
                      "name": "DYO",
                      "value": "15"
                  }
              ]
          }
      },
      "ReservationComment": [
          {
              "commentSource": "Agency",
              "shareWith": "Agency",
              "Comment": [ //this covers the general notepad, historical notepad, and confidential notepad remark types.
                  {
                      "name": "HS",
                      "value": "Added historical remark"
                  },
                  {
                      "name": "CF",
                      "value": "Added confidential remark"
                  },
                  {
                      "name": "R*",
                      "value": "Added regular remark with qualifier R"
                  },
                  {
                      "name": "QC",
                      "value": "Added regular remark with qualifiers Q and C"
                  },
              ]
          },
          {
              "commentSource": "Agency",
              "shareWith": "Traveler",
              "Comment": [ // this covers the unassociated remark type
                  {
                      "name": "ITIN COMMENTS",
                      "value": "This is an unassociated remark1"
                  },
                  {
                      "name": "ITIN COMMENTS",
                      "value": "This is an unassociated remark2"
                  }
              ]
          },
  

Create by Reference Payload response

• Updates as follows:

  • Identifier.value: Moved offer id into more logical position

  • Product.guests: Number of guests in request

  • Product.PropertyAddress: Address of property in reservation request

  • PriceBreakdown.Amount.Taxes.Tax

    • currencyCode: Currency involved

    • description: Type of tax

  • HotelPenalty.Percent

    • AppliesTo: Always amount

  • TermsAndConditionsFull.CheckInOutPolicy

    • checkInTime

    • checkOutTime

  • ReservationComment

    • Comment

      • value: Text of remark

      • name: Type of remark

    • AppliesTo

      • OfferIdentifier

        • offerRef: The hotel offer (segment) the remark directly applies to

  Code snippet

  {
      "ReservationResponse": {
          "Reservation": {
              "@type": "ReservationDetail",
              "Offer": [
                  {
                      "@type": "Offer",
                      "Identifier": {
                          "authority": "TVPT",
                          "value": "fd87b148-b7ec-436f-8947-e148ff31e81e:652a19984bcc4bf490ddf11270a784a7"
                      },
  
  
  "Product": [
                          {
                              "@type": "ProductHospitality",
                              "Quantity": 1,
                              "bookingCode": "B00XMIB",
                              "guests": 1,
                              "adaCompliant": "No",
                              "propertyName": "Houston Marriott Energy Corridor",
                              "PropertyAddress": {
                                  "AddressLine": [
                                      "16011 Katy Freeway"
                                  ],
                                  "City": "Houston",
                                  "StateProv": {
                                      "name": "TX"
                                  },
                                  "Country": {
                                      "name": "US"
                                  },
                                  "PostalCode": "77094"
                              },
  
  
  "PriceBreakdown": [
                              {
                                  "@type": "PriceBreakdownHospitality",
                                  "Amount": {
                                      "@type": "Amount",
                                      "CurrencyCode": {
                                          "value": "USD",
                                          "decimalPlace": 2
                                      },
                                      "Base": 405.00,
                                      "Taxes": {
                                          "@type": "TaxesDetail",
                                          "TotalTaxes": 121.91,
                                          "Tax": [
                                              {
                                                  "value": 121.91,
                                                  "currencyCode": "USD",
                                                  "taxCode": "17",
                                                  "description": "Total tax",
                                                  "includedInBase": "No"
                                              }
                                          ]
  
  
  "HotelPenalty": {
                                          "@type": "HotelPenaltyPercent",
                                          "appliesTo": "Amount",
                                          "Percent": 0
                                      },
  
  
  "TermsAndConditionsFull": [
                          {
                              "@type": "TermsAndConditionsFullHospitality",
                             
                              "CheckInOutPolicy": {
                                         "checkInTime": "15:00",
                                         "checkOutTime": "11:00"
                              },
  
  
  "ReservationComment": [
                  {
                      "@type": "ReservationComment",
                      "Comment": [
                          {
                              "value": "Please dont charge CC"
                          }
                      ],
                      "AppliesTo": [
                          {
                              "@type": "AppliesToOffer",
                              "OfferIdentifier": [
                                  {
                                      "offerRef": "O1"
                                  }
                              ]
                          }
                      ]
                  }
              ]
  

The following model changes were made with this release.

Create Reservation Reference Payload / Full Payload request

• Prefix: Traveler Title processing added

  Code snippet

  "Traveler": [
              {
                  "PersonName": {
                      "Given": "Cipria",
                      "Surname": "Marica",
                      "Prefix": "Lady"
                  },
  

Create by Reference Payload response

• Prefix: Traveler Title processing added

  Code snippet

  "Traveler": [
                  {
                      "id": "T2",
                      "PersonName": {
                          "Prefix": "LORD",
                          "Given": "Dan",
                          "Surname": "Nistor"
                      },
  

The following model changes were made with this release.

Create Reservation Reference Payload request

• None

Create by Reference Payload response

• Added code and includedIndicator fields in RoomAmenity object.

The following model changes were made with this release.

Create Reservation Reference Payload request

• New endpoint

• ReservationQueryBuild replaces ReservationDetail

• ReservationBuildFromCatalogOffering.BuildBromCatalogOfferingHospitality is used.

• numberOfRooms requested is expected in request: (If not present, defaults to 1)

• Offer ID construction no longer requires authority field

Create by Offer ID response

• Traveler id number generated by Travelport in Traveler and TravelerProduct objects

• Offer id number generated by Travelport in TravelerProduct, ReservationComment and Receipt objects

• New TravelerProduct object used to link traveler associated to room reservation (offer)

• ReservationComment.Comment adds name descriptor

• ReservationComment adds ApplysTo object to designate which offer is associated to the comment

The following model changes were made with this release.

Create request

• ReservationDetail replaces ReservationBackOffice for

• Added authority object.

• Improved Price, Traveler, and FormOfPayment objects.

• New structure for rate code information.

The following model changes were made with this release.

Create request

• None

Create by Offer ID response

• Added purpose field in Tax object.

• When returned, Commission and Description (rate description) display in the Price.PriceBreakdown.roomPricingType = Per stay section.

• When returned, AverageNightlyRate displays in the Price.PriceBreakdown.roomPricingType = Per night section.

The following model changes were made with this upgrade.

Create Reservation request

• ReservationDetail replaces ReservationBackOffice.

• Added authority object.

• Improved Price, Traveler, and FormOfPayment objects.

• New structure for rate code information.

Create Reservation response

• Added authority object.

• Changed currencyCode to CurrencyCode.

• All amount values are no longer enclosed with quotation marks.

• All true/false values are no longer enclosed with quotation marks.

• Improved RoomDescription and RateDescription objects.

• New structure for information on rate codes, commissions, bed configuration, meals, and cancel penalties.

• Improved Price and TermAndConditions objects.

• Expanded Traveler and Receipt objects.

The following model changes were made with this release.

Cancel request

• PUT message type replaces DEL

• New endpoints

Cancel response

• Traveler id number generated by Travelport in Traveler and TravelerProduct objects

• Offer id number generated by Travelport in TravelerProduct, ReservationComment and Receipt objects

• New TravelerProduct object used to link traveler associated to room reservation (offer)

• ReservationComment.Comment adds name descriptor

• ReservationComment adds ApplysTo object to designate which offer is associated to the comment

The following model changes were made with this upgrade.

Cancel request

• No changes.

Cancel response

• Added ReservationResponse object.

• Added Reservation object.

• Added Product object.

• Added Traveler object.

• Added Receipt object.

The following model changes were made with this release.

Modify request

• Reservation comments / Accounting, Notepad, Unassociated (see snippet)

  Code snippet

  "Accounting": {
              "@type": "Accounting", // this covers the accounting remark type
              "dataType": "DOCI",
              "NameValuePair": [
                  {
                      "name": "AC",
                      "value": "A53.IBM213.JAMES"
                  },
                  {
                      "name": "TK",
                      "value": "2040805184"
                  },
                  {
                      "name": "FT",
                      "value": "offerNumber.PTR 41641463345"
                  },
                  {
                      "name": "DYO",
                      "value": "15"
                  }
              ]
          }
      },
      "ReservationComment": [
          {
              "commentSource": "Agency",
              "shareWith": "Agency",
              "Comment": [ //this covers the general notepad, historical notepad, and confidential notepad remark types.
                  {
                      "name": "HS",
                      "value": "Added historical remark"
                  },
                  {
                      "name": "CF",
                      "value": "Added confidential remark"
                  },
                  {
                      "name": "R*",
                      "value": "Added regular remark with qualifier R"
                  },
                  {
                      "name": "QC",
                      "value": "Added regular remark with qualifiers Q and C"
                  },
              ]
          },
          {
              "commentSource": "Agency",
              "shareWith": "Traveler",
              "Comment": [ // this covers the unassociated remark type
                  {
                      "name": "ITIN COMMENTS",
                      "value": "This is an unassociated remark1"
                  },
                  {
                      "name": "ITIN COMMENTS",
                      "value": "This is an unassociated remark2"
                  }
              ]
          },
          {
              "commentSource": "Agency",
              "shareWith": "Traveler",
              "Comment": [ // this covers the associated remark type
                  {
                      "name": "ITIN COMMENTS",
                      "value": "This is an associated remark 1"
                  },
                  {
                      "name": "ITIN COMMENTS",
                      "value": "This is an associated remark 2"
                  }
              ],
              "AppliesTo": [
                  {
                      "@type": "AppliesToOffer",
                      "OfferIdentifier": [
                          {
                              "offerRef": "O1" //segment number
                          }
                      ]
                  }
              ]
          },
          {
              "commentSource": "Agency",
              "shareWith": "Traveler",
              "Comment": [
                  {
                      "name": "ITIN COMMENTS",
                      "value": "This is an associated remark 3"
                  }
              ],
              "AppliesTo": [
                  {
                      "@type": "AppliesToOffer",
                      "OfferIdentifier": [
                          {
                              "offerRef": "O2" //segment number
                          }
                      ]
                  }
              ]
          }
      ]
  }
  

Modify response

• Same changes as Create Reference Payload on same date.

The following model changes were made with this release.

Modify request

• Functionality of Traveler Name Modify extended to Booking.com and Expedia hotel segments

• Functionality of Credit Card Modify extended to Booking.com

• Functionality of Date Change Modify extended to Booking.com

Modify response

• No change

The following model changes were made with this release.

Modify request

• Name change restricted to names in PNR

• Added telephone number change capability

Modify response

• Traveler id number generated by Travelport in Traveler and TravelerProduct objects

• Offer id number generated by Travelport in TravelerProduct, ReservationComment and Receipt objects

• New TravelerProduct object used to link traveler associated to room reservation (offer)

• ReservationComment.Comment adds name descriptor

• ReservationComment adds ApplysTo object to designate which offer is associated to the comment

The following model changes were made with this upgrade.

Modify request

• ReservationDetail replaces ReservationBackOffice.

• Improved Traveler objects.

Modify response

• Added Authority object.

• Changed currencyCode to CurrencyCode.

• All amount values are no longer enclosed with quotation marks.

• Expanded Traveler and Receipt objects.

The following model changes were made with this release.

Add Reservation request

• None

Add by Reference Payload response

• Added code and includedIndicator fields in RoomAmenity object.

The following model changes were made with this release.

Add request

• No changes

Add response

• Traveler id number generated by Travelport in Traveler and TravelerProduct objects

• Offer id number generated by Travelport in TravelerProduct, ReservationComment and Receipt objects

• New TravelerProduct object used to link traveler associated to room reservation (offer)

• ReservationComment.Comment adds name descriptor

• ReservationComment adds ApplysTo object to designate which offer is associated to the comment

The following model changes were made with this upgrade.

Add request

• ReservationDetail replaces ReservationBackOffice.

• Added Authority object.

• Improved Price and FormOfPayment objects.

• New structure for rate code information.

• Created new Add by Offer ID request type.

Add response

• Added authority field.

• Changed currencyCode to CurrencyCode.

• All amount values are no longer enclosed with quotation marks.

• All true/false values are no longer enclosed with quotation marks.

• Improved Room Description and Rate Description fields.

• New structure for Rate Code information, Commission, Bed Configuration, Meal information, and Cancel Penalty.

• Improved Price object and Terms and Conditions object.

• Expanded Traveler and Receipt objects.

The following model changes were made with this release.

Retrieve Reservation request

• No changes

Retrieve Reservation response

• Prefix: Traveler Title processing added

  Code snippet

  "Traveler": [
                  {
                      "id": "T2",
                      "PersonName": {
                          "Prefix": "LORD",
                          "Given": "Dan",
                          "Surname": "Nistor"
                      },