Skip to main content

Get Hotel Lead Rate

3.0
Hotel
Search
REST API
Try now
release_note
  • 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'
  • Schema changes to support ability to AAA into a different PCC to retrieve negotiated / contractual rates in the future

API Information

Response Format
JSON
Method/Endpoint
GetHotelRateInfoRQPOST /v3.0.0/get/hotelleadrate
Current Version
3.0.0
Target Audience
TN
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'
  • Schema changes to support ability to AAA into a different PCC to retrieve negotiated / contractual rates in the future

New Features

In the Request

Optional

Parameter: POS

Type: object

Description: Allows user to AAA into a different PCC to retrieve negotiated / contractual rates if allowed.

Sample Value:

"POS": {
	"Source": {
		"PseudoCityCode": "TM61"
	}
}
Note: This is added to schemas as a future enhancement. Current functionality does not support this.

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

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'
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'
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'

Relase note ID: 13136