Skip to main content

View reservation ancillaries

Scenario: API Client wishes to view the ancillary order items on a reservation.

Ancillaries are included in the reservation response in the Packages collection. SynXis Retailing ancillaries always have "Type": "Dynamic". Static packages (configured outside of SynXis Retailing) may also be returned.

API client must be aware of differences in naming conventions between the Offer and Reservations API.

  • ChargeFrequency
    • Package PerNight = Offer PerInstance
    • Package PerStay = Offer PerOrder
  • ChargeType
    • Package PerOccupancyType = Offer PerAgeType
    • Package PerQuantityName = Offer FlatCharge

Hotel dictates will:

  • Have ChargeFrequency = PerNight.  
  • Contain a BookDays instance for each ‘included Date’ in the offer.  
{
   "ChargeFrequency":"PerNight",
   "ChargeType":"PerQuantityName",
   "GuestCount":[
      {
         "AgeQualifyingCode":"Adult",
         "NumGuests":2
      }
   ],
   "Price":{
      "CurrencyCode":"USD",
      "OriginalAmount":26.0,
      "TaxesFeesIncluded":false,
      "TotalAmount":26.0,
      "TotalAmountIncludingTaxesFees":26.0
   },
   "BookedDays":[
      {
         "GuestCount":[
            {
               "AgeQualifyingCode":"Adult",
               "NumGuests":2
            }
         ],
         "Price":{
            "CurrencyCode":"USD",
            "OriginalAmount":26.0,
            "TaxesFeesIncluded":false,
            "TotalAmount":26.0,
            "TotalAmountIncludingTaxesFees":26.0
         },
         "Date":"2025-10-02T00:00:00",
         "Quantity":1
      }
   ],
   "QuantityName":"Item",
   "PackageExternalReferenceList":[
      {
         "OrderItemNo":"AVN793RT20914",
         "Type":"Sip"
      }
   ],
   "Code":"TEST-A1-3",
   "Date":"2025-10-02T00:00:00",
   "Name":"TESTA1",
   "Quantity":1,
   "Time":"0001-01-01T00:00:00+00:00",
   "Type":"Dynamic",
   "ChargeCodes":[
      {
         "AllowanceAmount":0.0
      }
   ]
}