Skip to main content

Get Hotel Avail

Hotel
Search
REST API
Travel Agency
Try Now
  • Return a list of all available negotiated or contractual rates for a property.
  • Return rates from all sources without taxes or fees, allowing for a uniform comparison of rates between different sources.
  • Show supplier recommended selling rates to customers for net rates.
  • 'ConvertedRateInfoOnly' implementation has been changed to be more developer-friendly.
  • All OTA codes are now returned with descriptions, eliminating the need for customers to translate them.
  • Ability to filter properties based on the level of service.

API Information

Format
JSON
Endpoint
/v4.0.0/get/hotelavail
Current Version
4
Environment
Production

What's New

  • Return a list of all available negotiated or contractual rates for a property.
  • Return rates from all sources without taxes or fees, allowing for a uniform comparison of rates between different sources.
  • Show supplier recommended selling rates to customers for net rates.
  • 'ConvertedRateInfoOnly' implementation has been changed to be more developer-friendly.
  • All OTA codes are now returned with descriptions, eliminating the need for customers to translate them.
  • Ability to filter properties based on the level of service.

New Features

In the Request

Optional

Parameter: TravellerCountry

Type: string

Description: The traveller country field lets you pass this information on to suppliers that support this, allowing access to location-specific products in the availability response.

Sample Value:

{
   "RateInfoRef": {
      "CurrencyCode": "USD",
      "BestOnly": "1",
      "PrepaidQualifier": "ExcludePrepaid",
      "RefundableOnly": "false",
      "ConvertedRateInfoOnly": "true",
      "TravellerCountry": "US"
   }
}

In the Request

Optional

Parameter: OtherAvailableRatePlans

Type: boolean

Description: Allows customers to see a list of all available negotiated or contractual rates at the property, even if they are not the lowest rate and hence, not returned in the response.

Sample Value:

{
   "RatePlanCandidates": {
      "OtherAvailableRatePlans": "false"
   }
}

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"
         }
      }
   ]
}

In the Response

Optional

Parameter: AvailableRatePlans

Type: element

Description: The 'AvailableRatePlans' element returns a list of all available negotiated or contractual rates available at a property, even if they aren't the lowest rate and not returned in the API response.

Sample Value:

{
"AvailableRatePlans": {
"AvailableRatePlan": [
{
"RatePlanCode": "IBM",
"RatePlanType": "10",
"ClientId": "S93",
"RateSource": "100"
},
{
"RatePlanCode": "AMX",
"RatePlanType": "22",
"RateSource": "100"
}
]
}
}

In the Request

Optional

Parameter: PropertyQualityCodes

Type: element

Description: The property quality code filter allows users to filter properties based on the level of service. This field is based on the LOS OTA code.

Sample Value:

{
"PropertyQualityCodes": {
"Inclusive": false,
"PropertyQualityCode": [
15,
16
]
}
}

In the Response

Optional

Parameter: 'SearchLatitude' and 'SearchLongitude'

Type: number

Description: The response now includes the reference search latitude and longitude, irrespective of the option used under the 'GeoRef' element.

Sample Value:

{
"HotelAvailInfos": {
"OffSet": 2,
"MaxSearchResults": 763,
"ShopKey": "48ff454e-b83d-4c4f-aeb9-1bc9f3df8794",
"SearchLatitude": 32.758,
"SearchLongitude": -97.08
}
}

Functional Updates And Enhancements

In the Request

Optional

Parameter: RateSource

Type: element

Description: The 'InfoSource' element has been renamed to 'RateSource' to be in line with its functionality.

Sample Value:

{
   "RateSource": "100,110,112,113"
}

In the Response

Optional

Parameter: Hotel Codes

Type: string

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

Sample Value:

Request:
{
   "HotelRefs": {
      "HotelRef": {
         "HotelCode": "1234",
         "CodeContext": "SABRE"
      }
   }
}


Response
 {
          "HotelInfo": {
            "HotelCode": "100072188",
            "CodeContext": "GLOBAL",
            "SabreHotelCode": "8315",
            "HotelName": "Hyatt Regency Tulsa",
            "ChainCode": "HY",
            "ChainName": "Hyatt Hotels And Resorts",
...
}

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"
   }
}

In the Request

Optional

Parameter: ConvertedRateInfoOnly

Type: boolean

Description: The implementation of the 'ConvertedRateInfoOnly' attribute has been changed to make it developer-friendly. Refer to the API documentation for details.

In the Request

Optional

Parameter: SabreRating

Type: number

Description: The 'SabreRating' filter now allows you to filter properties with the lowest rating of 0.5, instead of 1.

Sample Value:

{
   "SabreRating": {
      "Min": "0.5",
      "Max": "0.5"
   }
}

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.


  • Content Services for Lodging APIs now provide the ability to search for and identify properties that have implemented enhanced safety protocols to provide a safe stay for the guests
  • A new amenity OTA code (2002) can be used to request and identify properties that support the Stay Safe initiative
  • Ability to filter hotels in the search request by making use of the AmenityCode filter that is already available, so no schema changes
  • For more information - https://developer.sabre.com/docs/safe_stay_indicator

API Information

Format
JSON
Current Version
3.0.0
Environment
Production

What's New

  • Content Services for Lodging APIs now provide the ability to search for and identify properties that have implemented enhanced safety protocols to provide a safe stay for the guests
  • A new amenity OTA code (2002) can be used to request and identify properties that support the Stay Safe initiative
  • Ability to filter hotels in the search request by making use of the AmenityCode filter that is already available, so no schema changes
  • For more information - https://developer.sabre.com/docs/safe_stay_indicator

Business Value

  • In the wake of the COVID-19 crisis, hotels around the globe are increasingly looking at improving cleanliness programs at their properties. Hotels want to provide guests with peace of mind and assure them that their room has been thoroughly sanitized. Whether it's guest rooms, restaurants, gyms, or other public areas, hotels want to make sure the health and safety of guests is a priority, now more than ever.
  • While our hotel partners have always taken providing clean rooms seriously, some are taking actions that go above and beyond standards provided by various governing bodies to meet the expectations presented by COVID-19. Several hoteliers are already implementing enhanced hotel cleaning practices, social interactions, and workplace protocols to meet new health and safety regulations.
  • This is of particular importance as Sabre connected travel agencies, Online Travel Agencies (OTAs), and corporations have a duty of care about the well-being of the traveler whilst they are on their trip.

New Features

In the Request

Optional

Parameter: AmenityCode

Type: String

Description: To request for only those properties that are a part of the “Stay Safe” program, AmenityCode 2002 must be added as a filter in the request.

Sample Value:

{
  "GetHotelAvailRQ": {
    "SearchCriteria": {
      "OffSet": 1,
      "SortBy": "TotalRate",
      "SortOrder": "DESC",
      "PageSize": 200,
      "GeoSearch": {
        "GeoRef": {
          "Radius": 200,
          "UOM": "MI",
          "RefPoint": {
            "Value": "AUS",
            "ValueContext": "CODE",
            "RefPointType": "6"
          }
        }
      },
      "RateInfoRef": {
        "CurrencyCode": "USD",
        "BestOnly": "1",
        "StayDateRange": {
          "StartDate": "2020-06-20",
          "EndDate": "2020-06-23"
        },
        "Rooms": {
          "Room": [
            {
              "Index": 1,
              "Adults": 2,
              "Children": 1,
              "ChildAges": "1"
            }
          ]
        }
      },
      "HotelPref": {
        "AmenityCodes": {
          "Inclusive": true,
          "AmenityCode": [
            2002
          ]
        }
      },
      "ImageRef": {
        "Type": "ORIGINAL",
        "CategoryCode": 2,
        "LanguageCode": "EN"
      }
    }
  }
}

In the Response

Optional

Parameter: Amenities

Type: String

Description: The Stay Safe indicator is returned as Amenities as Code 2002 in the API response for the properties that support Stay Safe initiative.

Sample Value:

"Amenities": {
                            "Amenity": [
                                {
                                    "Code": 2002,
                                    "Description": "Stay Safe",
                                    "value": ""
                                },
                                {
                                    "Code": 262,
                                    "Description": "Kitchenette",
                                    "value": ""
                                },
                                {
                                    "Code": 42,
                                    "Description": "Free parking",
                                    "value": ""
                                },
                                {
                                    "Code": 44,
                                    "Description": "Game room",
                                    "value": ""
                                },
                                {
                                    "Code": 55,
                                    "Description": "Hot Tub",
                                    "value": ""
                                }
                            ]
                        }

  • The response now shows both the Sabre Hotel Code and the Global ID
  • Product codes now returned in the response for GDS products in 'ProductCode'
  • Breakdown of tax and fee information by date range is now returned in 'Taxes' and 'Fees' elements
  • Updated structure of element 'Guarantee'
  • Added ability to view Security Features mapped to a property
  • Amenities can now have a text description associated to them
  • Added 'RateDetailsInd' attribute to request to control whether only hotels with rates are shown in the response
  • Added ability to shop in an authorized (AAA Access) branch location (PCC) while remaining signed-into the home branch or IPCC

API Information

Format
JSON
Endpoint
/POST /v3.0.0/get/hotelavail
Current Version
3.0.0
Environment
Production

What's New

  • The response now shows both the Sabre Hotel Code and the Global ID
  • Product codes now returned in the response for GDS products in 'ProductCode'
  • Breakdown of tax and fee information by date range is now returned in 'Taxes' and 'Fees' elements
  • Updated structure of element 'Guarantee'
  • Added ability to view Security Features mapped to a property
  • Amenities can now have a text description associated to them
  • Added 'RateDetailsInd' attribute to request to control whether only hotels with rates are shown in the response
  • Added ability to shop in an authorized (AAA Access) branch location (PCC) while remaining signed-into the home branch or IPCC

New Features

In the Response

Optional

Parameter: SabreHotelCode

Type: string

Description: Sabre Hotel Code of a Global ID.

Sample Value:

53121
Note: Populated only if a Global ID has a Sabre Hotel Code mapped to it, and the search was made with the Global ID

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 Request

Optional

Parameter: SecurityFeatures

Type: boolean

Description: Boolean field to control whether you want to see security features in the response

Sample Value:

"SecurityFeatures": "false"
Note: Default false. When true, Security feature information is returned in the response

In the Response

Optional

Parameter: SecurityFeatures

Type: object

Description: Security features (mapped to SEC OTA Code) applicable to a property

Sample Value:

"SecurityFeatures": {
  "SecurityFeature": [
    {
      "Code": 9,
      "Description": "Complies with Local/State/Federal fire laws",
      "value": "Fire safety law compliant"
    }
  ]
}

In the Request

Optional

Parameter: RateDetailsInd

Type: boolean

Description: Boolean flag to control whether only hotels with rates are shown in the response

Sample Value:

"RateDetailsInd": "true"
Note: Default true. When true, only hotels with rates will be shown in the response

In the Request

Optional

Parameter: POS

Type: object

Description: Allows shopping 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 shopping 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 associated to an Amenity