Skip to main content

Hotel Price Check

v3
Hotel
Pricing
REST API
Travel Agency
Try Now
release_note
  • Added 'HotelInfo' element to response so API returns basic descriptive hotel information
  • Breakdown of tax and fee information by date range is now returned in 'Taxes' and 'Fees' elements
  • Updated structure of element 'Guarantee'
  • Product codes now returned in the response for GDS products in 'ProductCode'
  • Added ability to price in an authorized (AAA Access) branch location (PCC) while remaining signed-into the home branch or IPCC

API Information

Response Format
JSON
Method/Endpoint
HotelPriceCheckRQPOST /v3.0.0/hotel/pricecheck
Current Version
3.0.0
Target Audience
TN
Environment
Production

What's New

  • Added 'HotelInfo' element to response so API returns basic descriptive hotel information
  • Breakdown of tax and fee information by date range is now returned in 'Taxes' and 'Fees' elements
  • Updated structure of element 'Guarantee'
  • Product codes now returned in the response for GDS products in 'ProductCode'
  • Added ability to price in an authorized (AAA Access) branch location (PCC) while remaining signed-into the home branch or IPCC

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

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

Relase note ID: 13353


  • The HotelPriceCheckRQ 2.0.0 API is a step between Shopping and Booking. It checks whether the price returned in shopping for a chosen product is the same.

API Information

Response Format
JSON
Method/Endpoint
POST /v2.0.0/hotel/pricecheck
Current Version
2.0.0
Target Audience
TN
Environment
Production

What's New

  • The HotelPriceCheckRQ 2.0.0 API is a step between Shopping and Booking. It checks whether the price returned in shopping for a chosen product is the same.

Relase note ID: 12871