New Features

In the Response

Optional

Parameter: MinSellingRate

Type: decimal

Description: Returns the supplier recommended selling price for the rate, if returned. This is generally populated for net rates.

Sample Value:

{
   "RateInfo": {
      "StartDate": "2021-10-20",
      "EndDate": "2021-10-24",
      "AmountBeforeTax": "760.60",
      "AmountAfterTax": "882.40",
      "MinSellingRate": "900.00"
   }
}

Note: If populated, this is returned for each RateInfo or ConvertedRateInfo element in the response

In the Response

Optional

Parameter: AverageNightlyRateBeforeTax

Type: decimal

Description: Irrespective of the source, the 'AverageNightlyRateBeforeTax' field will always be populated in the response, returning the overall averaged (not highest) nightly rate without considering any taxes or fees.

Sample Value:

{
   "RateInfo": {
      "StartDate": "2021-10-20",
      "EndDate": "2021-10-24",
      "AmountBeforeTax": "760.60",
      "AmountAfterTax": "882.40",
      "AverageNightlyRate": "220.60",
      "AverageNightlyRateBeforeTax": "190.15",
      "CurrencyCode": "USD"
   }
}

In the Response

Optional

Parameter: All OTA Code elements will now be accompanied with an attribute with the description of that OTA code.

Type: string

Description: This change applies to all OTA codes in the API responses, including but not limited to 'RoomTypeCode', 'RatePlanInclusion', 'Amenity', 'TaxGroups' and 'FeeGroups'.

Sample Value:

"RatePlanInclusion": {
  "Code": "222",
  "Description": "Free high speed internet connection"
},
"TaxGroup": {
  "Code": "13",
  "Description": "Sales Tax",
  "Amount": "40.00",
  "CurrencyCode": "USD"
},
"FeeGroup": {
  "Code": "2",
  "Description": "City Hotel Fee",
  "Amount": "25.00",
  "CurrencyCode": "USD"
}

In the Response

Optional

Parameter: CVVRequired

Type: boolean

Description: When specifically returned by suppliers, this boolean field is populated in the response to indicate that a CVV number is mandatory when booking.

Sample Value:

{
   "GuaranteeAccepted": {
      "GuaranteeTypeCode": "5",
      "GuaranteeTypeDescription": "Credit Card",
      "PaymentCards": {
         "CVVRequired": "true",
         "PaymentCard": [
            {
               "CardCode": "VI",
               "value": "VISA"
            },
            {
               "CardCode": "MC",
               "value": "MASTER CARD"
            }
         ]
      }
   }
}

In the Response

Optional

Parameter: DepositPolicies

Type: element

Description: The 'DepositPolicies' element now contains a list of multiple policies for rates that may have varying deposit policies based on the dates for a reservation.

Sample Value:

{
   "DepositPolicies": [
      {
         "Deadline": {
            "AbsoluteDeadline": "202-10-12T18:00:00"
         },
         "AmountPercent": {
            "NmbrOfNights": "1",
            "Amount": "176.48"
         }
      },
      {
         "Deadline": {
            "AbsoluteDeadline": "202-10-18T18:00:00"
         },
         "AmountPercent": {
            "NmbrOfNights": "1",
            "Amount": "176.48"
         }
      }
   ]
}

Functional Updates And Enhancements

In the Response

Optional

Parameter: Hotel Codes

Type: string

Description: The response will now always return Global hotel codes irrespective of whether the rateKey was generated using a Sabre or a Global hotel code. If the property is also available from Sabre, a 'SabreHotelCode' and the 'ChainCode' will be returned in the response.

Sample Value:

{
   "HotelInfo": {
      "HotelCode": "100095296",
      "CodeContext": "GLOBAL",
      "SabreHotelCode": "1234",
      "ChainCode": "IQ"
   }
}

In the Response

Optional

Parameter: AmountBeforeTax

Type: decimal

Description: The 'AmountBeforeTax' is now always returned in the response, irrespective of the source being shopped.

Sample Value:

amountbeforetax
{
   "RateInfo": {
      "StartDate": "2021-10-20",
      "EndDate": "2021-10-24",
      "AmountBeforeTax": "760.60",
      "AmountAfterTax": "882.40",
      "AverageNightlyRate": "220.60",
      "AverageNightlyRateBeforeTax": "190.15",
      "CurrencyCode": "USD",
      "AdditionalFeesInclusive": "true",
      "TaxInclusive": "true"
   }
}

In the Response

Optional

Parameter: LoyaltyId

Type: string

Description: The 'LoyaltyId' attribute has been removed from the 'RateInfos' element and instead moved inside the Rooms -> Room -> RatePlans -> RatePlan element since it reflects the rate plan and not rates.

Sample Value:

{
   "RatePlan": {
      "RatePlanName": "Room, 2 Double Beds",
      "RatePlanCode": "AARP",
      "RatePlanType": "1",
      "LoyaltyId": "IQ1234"
   }
}

Resolved Issues

In the Response

Optional

Description: Rate-related additional details will now be populated in the 'AdditionalDetails' element inside the 'RateInfo' element for all sources, removing an inconsistency where it was sometimes populated under the 'Rooms' element.

New Features

In the Response

Optional

Parameter: ProductCode

Type: string

Description: Inventory code uniquely identifying a GDS product

Sample Value:

A1KRAC

Note: Populated only for GDS products; not for Aggregator products

In the Response

Optional

Parameter: HotelInfo

Type: object

Description: Contains static hotel information such as chain code and address

Sample Value:

"HotelInfo": {
  "HotelCode": "100072188",
  "CodeContext": "GLOBAL",
  "SabreHotelCode": "8317",
  "HotelName": "Hyatt Regency Tulsa",
  "ChainCode": "HY",
  "ChainName": "Hyatt Hotels And Resorts",
  "BrandCode": "10008",
  "BrandName": "Hyatt",
  "SabreRating": "3.5",
  "CurrencyCode": "USD",
  "LocationInfo": {
    "Latitude": "36.154800",
    "Longitude": "-95.990356",
    "Address": {
      "AddressLine1": "50 N MARTINGALE RD",
      "AddressLine2": "Pointer Square",
      "AddressLine3": "Orlando",
      "CityName": {
        "CityCode": "TUL",
        "value": "Tulsa"
      },
      "StateProv": {
        "StateCode": "OK",
        "value": "Oklahoma"
      },
      "PostalCode": "60173",
      "CountryName": {
        "Code": "US",
        "value": "United States"
      }
    },
    "Neighborhoods": {
      "Neighborhood": [
        {
          "Id": "90000092",
          "value": "Tulsa OK"
        }
      ]
    },
    "Contact": {
      "Phone": "999-222-1111",
      "Fax": "999-222-1110"
    }
  }
}

In the Request

Optional

Parameter: POS

Type: object

Description: Allows pricing in an authorized (AAA Access) branch location (PCC) while remaining signed-into the home branch or IPCC

Sample Value:

"POS": {
    "Source": {
        "PseudoCityCode": "TM61"
    }
}

Note: Although the price validation happens in the branch location PCC given in the request, the underlying Session or Token used to authenticate or call this API remains unchanged. This is different from how AAA branch shopping worked in legacy GDS where the underlying session itself is AAAed into the branch location

Functional Updates And Enhancements

In the Response

Optional

Parameter: Taxes

Type: object

Description: Taxes contains the breakdown of tax information by date range and type

Sample Value:

"Taxes": {
    "Amount": 22.46,
    "CurrencyCode": "AUD",
    "Tax": [{
        "StartDate": "2019-09-20",
        "EndDate": "2019-09-22",
        "Amount": 11.23,
        "CurrencyCode": "AUD"
    }],
    "TaxGroups": {
        "TaxGroup": [{
            "Code": 36,
            "Amount": 22.46,
            "CurrencyCode": "AUD",
            "TaxDescription": {
                "Text": [
                    "Value Added Tax"
                ]
            }
        }]
    }
}

Note: Changed structure of 'Taxes'

In the Response

Optional

Parameter: Fees

Type: object

Description: Fees contains the breakdown of fee information by date range and type

Sample Value:

"Fees": {
    "Amount": 22.46,
    "CurrencyCode": "AUD",
    "Fee": [{
        "StartDate": "2019-09-20",
        "EndDate": "2019-09-22",
        "Amount": 11.23,
        "CurrencyCode": "AUD"
    }],
    "FeeGroups": {
        "FeeGroup": [{
            "Code": 12,
            "Amount": 22.46,
            "CurrencyCode": "AUD",
            "FeeDescription": {
                "Text": [
                    "Resort Fee"
                ]
            }
        }]
    }
}

Note: Changed structure of 'Fees'

In the Response

Optional

Parameter: Guarantee

Type: object

Description: Guarantee information related to Product

Sample Value:

"Guarantee": {
    "GuaranteeType": "GUAR",
    "GuaranteesAccepted": {
      "GuaranteeAccepted": [
        {
          "GuaranteeTypeCode": 5,
          "PaymentCards": {
            "PaymentCard": [
              {
                "CardCode": "AX",
                "value": "American Express"
              }
            ]
          }
        }
      ]
    },
    "Deadline": {
      "AbsoluteDeadline": "2018-07-01T23:59:00",
      "OffsetTimeUnit": "Day",
      "OffsetUnitMultiplier": 2,
      "OffsetDropTime": "BeforeArrival"
    },
    "AmountPercent": {
      "TaxInclusive": true,
      "FeesInclusive": true,
      "NmbrOfNights": 12,
      "BasisType": "Basis Type",
      "Percent": 12.01,
      "Amount": 84.12,
      "CurrencyCode": "AUD",
      "ApplyAs": "Apply As"
    },
    "GuaranteeDescription": {
      "Text": [
        "A pre-arrival deposit that is given back to the traveler after a completed stay."
      ]
    }
}

Note: Updated structed of 'Guarantee'

In the Response

Optional

Parameter: Amenities

Type: object

Description: Amenities available at the property

Sample Value:

"Amenities": {
  "Amenity": [
    {
      "Code": 15,
      "Description": "Car rental desk",
      "ComplimentaryInd": false,
      "value": "Ask at reception for car rental charges"
    }
  ]
}

Note: Amenities can now have text information assosciated to an Amenity