CheckRates

Why checkrates is needed

The checkrates method can complement the booking process, as it returns additional information to the availability request. However, when the rateType value is "RECHECK", the checkrates method is mandatory.

The rateType value "RECHECK" is returned for rates that do not have real-time availability. This is, that come from accommodation partners that update their products in our system periodically, with varying frequency depending on the supplier itself, the destination, hotels, etc.

The checkrates method response contains the same information provided in the availability response, but returns information only for a specific hotel and rate. The purpose of this method is double check availability and prices for any particular hotel/rate.

The prices obtained via this method are always up-to-date; along with some other information: rate breakdown, rate comments and upselling options.

 

ENDPOINT:  POST https://api.test.hotelbeds.com/hotel-api/1.0/checkrates

 

Request parameters

Node/Attribute

Type

Mandatory

Description

checkRateRQ Element Y Top level
checkRateRQ/@language String N Response language
checkRateRQ/@upselling String N

Add an upselling node to the response. It contains additional room options at the same hotel, each with its own rate key.

checkRateRQ/rooms

Array of room elements

Y

List of Room elements

checkRateRQ/rooms/room Element Y Room element
checkRateRQ/rooms/room/@rateKey String Y Room rateKey returned in the availabilityRS with all the information needed to obtain rate details and to confirm the booking

 

Request XML Example

<checkRateRQ xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" language="CAS" upselling="True">
	<rooms>
		<room rateKey="20161202|20161203|W|1|96004|JSU.ST|NRF-TODOS|RO||1~2~0||N@626351087"/>
		<room rateKey="20161202|20161203|W|1|96004|JSU.ST|NRF-TODOS|RO||1~2~0||N@626351087"/>
	</rooms>
</checkRateRQ>

 

Request JSON Example

{
    "language": "CAS",
    "upselling":"True", 
    "rooms": [
        {
            "rateKey": "20161202|20161203|W|1|96004|JSU.ST|NRF-TODOS|RO||1~2~0||N@626351087"
        },
        {
            "rateKey": "20161202|20161203|W|1|96004|JSU.ST|NRF-TODOS|RO||1~2~0||N@626351087"
        }
    ]
}

 

CheckRates Response

Important information for customers

It is important to check the rateComments attribute because it contains important information provided by hoteliers that should be shown to the customer prior to confirming the booking.

Promotions, discounts & supplements

A price breakdown is returned with promotions and discounts already applied to the rate. Additionally, the supplements are included in the checkrates response.

[...]

 

<?xml version="1.0"?>
<rate rateKey="20150925|20150926|W|77|233475|DBL.NY|B2C|BB||1~1~1|5|N@1243057120" rateClass="NOR" rateType="BOOKABLE" net="57.010" sellingRate="61.100" hotelMandatory="true" rateComments=" . " paymentType="AT_WEB" packaging="false" boardCode="BB" boardName="BED AND BREAKFAST" rooms="1" adults="1" children="1" childrenAges="5">
	<cancellationPolicies>
		<cancellationPolicy amount="57.010" from="2015-09-22T23:59:00Z"/>
	</cancellationPolicies>
	<rateBreakDown>
		<rateDiscounts>
			<rateDiscount code="LMD" name="Last Minute discount" amount="-30.690"/>
		</rateDiscounts>
	</rateBreakDown>
</rate>

 

[...]

Upselling options

[...]

 

 <upselling>
	<rooms>
		<room code="DBL.ST" name="DOUBLE-STANDARD">
			<rates>
				<rate rateKey="20150925|20150926|W|77|233475|DBL.ST|B2C|BB||1~1~1|5|N@2042626905" rateClass="NOR" rateType="BOOKABLE" net="68.520" sellingRate="73.450" hotelMandatory="true" allotment="3" paymentType="AT_WEB" packaging="false" boardCode="BB" boardName="BED AND BREAKFAST" rooms="1" adults="1" children="1" childrenAges="5" rateup="12.350">
					<cancellationPolicies>
						<cancellationPolicy amount="68.520" from="2015-09-22T23:59:00Z"/>
					</cancellationPolicies>
					<promotions>
						<promotion code="9007" name="Last minute discount"/>
						<promotion code="9002" name="Early Booking discount"/>
					</promotions>
					<offers>
						<offer code="9007" name="Last minute discount" amount="-36.900"/>
					</offers>
				</rate>
			</rates>
		</room>
	</rooms>
</upselling>

 

[...]

Response parameters

Node/Attribute

Type

Description

checkRateRS

Element

Top Element

checkRateRS/auditData

Element

Relevant internal information

checkRateRS/auditData/@processTime

Float

Server process time in milliseconds

checkRateRS/auditData/@timestamp

Date

Date/time when the requests have been processed

checkRateRS/auditData/@requestHost String IP address of the system host

checkRateRS/auditData/@serverId

String

Server code or ID (for internal use)

checkRateRS/auditData/@environment

String

Environment where the request has been sent and processed

checkRateRS/auditData/@release String Release version identifier
checkRateRS/auditData/@token String Token identifier of the operation
checkRateRS/auditData/@internal String Internal identifier of the parameters of the operation

checkRateRS/hotel

Element

Element that contains information about the hotel and associated rates

checkRateRS/hotel/@checkIn

Date

Check-in date

checkRateRS/hotel/@checkOut

Date

Check-out date

checkRateRS/hotel/@name

String

Hotel name

checkRateRS/hotel/@code

Int

Hotebeds internal hotel code

checkRateRS/hotel/@description

 

Hotel address

checkRateRS/hotel/@categoryCode

String

Hotel category code

checkRateRS/hotel/@categoryName

 

Category name

checkRateRS/hotel/@destinationCode

String

Destination code for hotel location

checkRateRS/hotel/@destinationName

String

Destination name for hotel location

checkRateRS/hotel/@zoneCode

Int

Zone code for hotel location

checkRateRS/hotel/@zoneName

String

Zone name for hotel location

checkRateRS/hotel/@latitude

Float

Latitude data for geolocation

checkRateRS/hotel/@longitude

Float

Longitude data for geolocation

checkRateRS/hotel/@currency

String

Client currency 

checkRateRS/hotel/@maxRate

Float

Maximum room price for the hotel

checkRateRS/hotel/@minRate

Float

Minimum room price for the hotel

checkRateRS/hotel/@giata

Int

Giata hotel code

checkRateRS/hotel/@currency

String

Client currency

checkRateRS/hotel/creditCards

Array of credit cards

List of credit cards accepted by the hotel in case of "pay at hotel" model

checkRateRS/hotel/creditCards/creditCard

Element

Element that contains information about the credit card

checkRateRS/hotel/creditCards/creditCard/@code

Int

Credit card code

checkRateRS/hotel/creditDards/creditCard/@name

String

Credit card name

checkRateRS/hotel/creditDards/creditCard/@paymentType

String

Type of payment

AT_HOTEL

AT_WEB

checkRateRS/hotel/rooms

Array of room elements

List of rooms available for a particular hotel

checkRateRS/hotel/rooms/room/

Element

Element that contains information about the room and associated rates

checkRateRS/hotel/rooms/room/@code

Int

Internal room code

checkRateRS/hotel/rooms/room/@name

String

Room name

checkRateRS/hotel/rooms/room/rates/rate/@rateKey

String

Internal rate key to be used for confirmation

checkRateRS/hotel/rooms/room/rates/rate/@rateClass

String

Internal rate class type (NOR NRF, SPE, OFE, PAQ ...)

checkRateRS/hotel/rooms/room/rates/rate/@rateType

String

Whether the booking can be confirmed in two steps (BOOKABLE) or three steps (RECHECK)

checkRateRS/hotel/rooms/room/rates/rate/@paymentType

String

Identifies if it is pay at hotel or merchant

checkRateRS/hotel/rooms/room/rates/rate/@packaging

String

Identifies if the rate is for packaging

checkRateRS/hotel/rooms/room/rates/rate/@boardCode

String

Internal board code

checkRateRS/hotel/rooms/room/rates/rate/@boardName

String

Board name

checkRateRS/hotel/rooms/room/rates/rate/@net

Float

Room net price

checkRateRS/hotel/rooms/room/rates/rate/@sellingRate

Float

Room gross price in case it is included

checkRateRS/hotel/rooms/room/rates/rate/@comission

Float

Agency commission

checkRateRS/hotel/rooms/room/rates/rate/@comissionPCT

Float

Percentage of the commission

checkRateRS/hotel/rooms/room/rates/rate/@comissionVat

Float

VAT commission

checkRateRS/hotel/rooms/room/rates/rate/@hotelSellingRate

Float

Room gross price in hotelCurrency (for the pay at hotel model)

checkRateRS/hotel/rooms/room/rates/rate/@hotelCurrency

String

Hotel currency (for the pay at hotel model)

checkRateRS/hotel/rooms/room/rates/rate/@hotelMandatory

Boolean

Identifies if the rate price is recommended

checkRateRS/hotel/rooms/room/rates/rate/@rooms

Int

Number of rooms requested with the same occupancy

checkRateRS/hotel/rooms/room/rates/rate/@adults

Int

Number of adults requested for each room

checkRateRS/hotel/rooms/room/rates/rate/@children

Int

Number of children requested for each room

checkRateRS/hotel/rooms/room/rates/rate/@rateComments

String

Rate comments that contain important information (max lenght = 4000 characters)

checkRateRS/hotel/rooms/room/rates/rate/cancellationPolicies

Array of policies elements

List of cancellation policies

checkRateRS/hotel/rooms/room/rates/rate/cancellationPolicies/policy

Element

Cancellation policies element

checkRateRS/hotel/rooms/room/rates/rate/cancellationPolicies/policy/@amount

Float

Amount that will be charged after date from

checkRateRS/hotel/rooms/room/rates/rate/cancellationPolicies/policy/@from

Date

Beginning date when the amount will be charged

checkRateRS/hotel/rooms/room/rates/rate/cancellationPolicies/policy/@hotelAmount

Floar

Amount that will be charged after a certain date, provided in hotel currency (for the pay at hotel model)

checkRateRS/hotel/rooms/room/rates/rate/rateBreakDown

Element

Rate breakdown element

checkRateRS/hotel/rooms/room/rates/rate/rateBreakDown/rateDiscounts

Element

Discount element

checkRateRS/hotel/rooms/room/rates/rate/rateBreakDown/rateDiscounts/rateDiscount/@amount

Float

Amount of the discount

checkRateRS/hotel/rooms/room/rates/rate/rateBreakDown/rateDiscounts/rateDiscount/@code

Int

Discount code

checkRateRS/hotel/rooms/room/rates/rate/rateBreakDown/rateDiscounts/rateDiscount/@name

String

Discount name/description

checkRateRS/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements

Element

Supplement element

checkRateRS/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@amount

Float

Amount of the supplement

checkRateRS/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@code

Int

Supplement internal code

checkRateRS/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@from

Date

Date when the supplement begins to apply

checkRateRS/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@to

Date

Date when the supplement stops applying

checkRateRS/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@nights

Int

Number of nights for which the supplement applies

checkRateRS/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@paxNumber

int

Number of paxes that are affected by the supplement

checkRateRS/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@paxType

String

Pax type affected

checkRateRS/hotel/rooms/room/rates/rate/offers

Array of offer elements

List of offers

checkRateRS/hotel/rooms/room/rates/rate/offers/offer

Element

Element that contains offer information

checkRateRS/hotel/rooms/room/rates/rate/offers/offer/@code

Int

Offer code

checkRateRS/hotel/rooms/room/rates/rate/offers/offer/@amount

Float

Offer amount

checkRateRS/hotel/rooms/room/rates/rate/offers/offer/@name

String

Offer name

checkRateRS/hotel/rooms/room/rates/rate/promotions

Array of promotion elements

List of promotions for a particular rate

checkRateRS/hotel/rooms/room/rates/rate/promotions/promotion

Element

Element that contains promotion information

checkRateRS/hotel/rooms/room/rates/rate/promotions/promotion/@code

Int

Promotion code

checkRateRS/hotel/rooms/room/rates/rate/promotions/promotion/@name

String

Short description of the promotion

checkRateRS/hotel/rooms/room/rates/rate/promotions/promotion/@remark

String

Promotion remark

checkRateRS/hotel/rooms/room/rates/rate/taxes

Array of tax elements

List of prices with taxes included or excluded

checkRateRS/hotel/rooms/room/rates/rate/taxes/@allIncluded

Boolean

Indicates if all taxes are included or not

checkRateRS/hotel/rooms/room/rates/rate/taxes/tax

Element

Element that contains the information about the tax

checkRateRS/hotel/rooms/room/rates/rate/taxes/tax/@included

Boolean

Indicates if the tax is included in the price or not

checkRateRS/hotel/rooms/room/rates/rate/taxes/tax/@import

Float

Value of the tax

checkRateRS/hotel/rooms/room/rates/rate/taxes/tax/@hotelImport

Float

Value of the tax in hotel currency if the tax is not included in the price

checkRateRS/hotel/rooms/room/rates/rate/taxes/tax/@hotelCurrency

String

Hotel currency

checkRateRS/hotel/rooms/room/rates/rate/taxes/tax/@percentage

Float

Percentage to be paid at the hotel

checkRateRS/hotel/upSelling

Array of rooms

Room options available apart from the one selected

checkRateRS/hotel/upSelling/rooms/room/rates/rate/@rateKey

String

Internal rate key to be used for confirmation

checkRateRS/hotel/upSelling/rooms/room/rates/rate/@rateClass

String

Internal rate class type (NOR NRF, SPE, OFE, PAQ ...)

checkRateRS/hotel/upSelling/rooms/room/rates/rate/@rateType

String

Whether or not room is available

checkRateRS/hotel/upSelling/rooms/room/rates/rate/@paymentType

String

Identifies if it is pay at hotel or merchant 

checkRateRS/hotel/upSelling/rooms/room/rates/rate/@packaging

String

Identifies if the rate is for packaging

checkRateRS/hotel/upSelling/rooms/room/rates/rate/@boardCode

String

Internal board code

checkRateRS/hotel/upSelling/rooms/room/rates/rate/@boardName

String

Board name

checkRateRS/hotel/upSelling/rooms/room/rates/rate/@net

Float

Room net price

checkRateRS/hotel/upSelling/rooms/room/rates/rate/@sellingRate

Float

Room gross price if it is included

checkRateRS/hotel/upSelling/rooms/room/rates/rate/@comission

Float

Commission for commissionable model

checkRateRS/hotel/upSelling/rooms/room/rates/rate/@hotelSellingRate

Float

Room gross price in hotelCurrency (for the pay at hotel model)

checkRateRS/hotel/upSelling/rooms/room/rates/rate/@hotelCurrency

String

Hotel currency (for the pay at hotel model)

checkRateRS/hotel/upSelling/rooms/room/rates/rate/@hotelMandatory

Boolean

Identifies if the rate price is recommended

checkRateRS/hotel/upSelling/rooms/room/rates/rate/@allotment

Int

Number of rooms available for a particular room type

checkRateRS/hotel/upSelling/rooms/room/rates/rate/@rooms

Int

Number of rooms requested of the type

checkRateRS/hotel/upSelling/rooms/room/rates/rate/@adults

Int

Number of adults for each room

checkRateRS/hotel/upSelling/rooms/room/rates/rate/@children

Int

Number of children requested for each room

checkRateRS/hotel/upSelling/rooms/room/rates/rate/@rateComments

String

Rate comments that contain important information (max lenght = 4000 characters)

checkRateRS/hotel/upSelling/rooms/room/rates/rate/@rateup

Float

Difference between original rate price and upselling rate price

checkRateRS/hotel/upSelling/rooms/room/rates/rate/cancellationPolicies

Array of policies elements

List of cancellation policies

checkRateRS/hotel/upSelling/rooms/room/rates/rate/cancellationPolicies/policy

Element

Element of cancellation policy

checkRateRS/hotel/upSelling/rooms/room/rates/rate/cancellationPolicies/policy/@amount

Float

Amount that will be charged after date from

checkRateRS/hotel/upSelling/rooms/room/rates/rate/cancellationPolicies/policy/@from

Date

Date from where the amount will be charged

checkRateRS/hotel/upSelling/rooms/room/rates/rate/cancellationPolicies/policy/@hotelAmount

Float

Amount that will be charged after a certain date, provided in hotel currency (for the pay at hotel model)

 

XML Response Example

<?xml version="1.0" encoding="UTF-8"?>
<checkRateRS xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" schemaLocation="http://www.hotelbeds.com/schemas/messages">
	<auditData processTime="54" timestamp="2016-07-28 14:23:15.380" requestHost="212.170.239.110" serverId="sa37AUX3ROLBLIS.env" environment="[int, ignite]" release="8f8516c469363d54ffa94ee260b468578804460f" token="a4d980f2-812c-49f2-9c28-48019897bd47" internal="3sep63ebyzgpuszmj8erpk6r|ES|null|null|null|null|0|0|0|N|null|null|null|null|null||||1"/>
	<hotel checkIn="2016-12-19" checkOut="2016-12-20" code="97793" name="Doubletree by Hilton Orlando Downtown" categoryCode="4EST" categoryName="4 STARS" destinationCode="MCO" destinationName="Orlando Area - Florida - FL" zoneCode="6" zoneName="Downtown" latitude="28.558849" longitude="-81.378806" totalNet="79.09" currency="EUR">
		<rooms>
			<room code="DBL.ST" name="DOUBLE">
				<rates>
					<rate rateKey="20161219|20161220|W|235|97793|DBL.ST|STA|RO||1~2~0||N@-1519909934" rateClass="SPE" rateType="BOOKABLE" net="79.09" rateComments="The person whose name is on the reservation must be at least 21 years of age to check in.&#xa;The hotel offers cribs and parking (self/valet) at an addtional fee paid locally at the hotel check in by guest&#xa; .  " paymentType="AT_WEB" packaging="false" boardCode="RO" boardName="ROOM ONLY" rooms="1" adults="2" children="0">
						<cancellationPolicies>
							<cancellationPolicy amount="79.09" from="2016-12-15T23:59:00-05:00"/>
						</cancellationPolicies>
					</rate>
				</rates>
			</room>
		</rooms>
	</hotel>
</checkRateRS>

 

JSON Response Example

{
	"auditData": {
		"processTime": "59",
		"timestamp": "2015-09-14 11:26:08.395",
		"requestHost": "212.170.239.110",
 		"serverId": "ws3xmi01",
		"environment": "[itest, iSET_A, ehcache]",
		"release": "4838",
		"token": "a4d980f2-812c-49f2-9c28-48019897bd47",
		"internal": "|null|null|null|null|0|0|0|N|null|null|null|null|null||||1"
	},
	"hotel": {
		"checkIn": "2016-06-07",
		"checkOut": "2016-06-09",
		"code": 2643,
		"name": "Club Marthas",
		"categoryCode": "4EST",
		"categoryName": "4 STARS",
		"destinationCode": "PMI",
		"destinationName": "Majorca",
		"zoneCode": 90,
		"zoneName": "Cala d'Or",
		"latitude": "39.364207",
		"longitude": "3.226974",
		"rooms": [{
			"code": "APT.1B-C4",
			"name": "APARTMENT",
			"rates": [{
				"rateKey": "2643|APT.1B-C4|REP-OPACO|1|AI||1~2~2|8~8|20160607|20160609|W|N#-1095663616",
				"rateClass": "NOR",
				"rateType": "BOOKABLE",
				"net": "413.200",
				"rateComments": "BABY COT 4€ PAY DIRECTLY IN THE HOTEL Estimated total amount of taxes & fees for this booking: Estimated total amount of taxes & fees for this booking: payable on arrival. ",
				"paymentType": "AT_WEB",
				"packaging": false,
				"boardCode": "AI",
				"boardName": "ALL INCLUSIVE",
				"cancellationPolicies": [{
					"amount": "206.600",
					"from": "2016-06-07T00:00:00+02:00"
				}],
				"rateBreakDown": {
					"rateDiscounts": [{
						"code": "EB",
						"name": "EARLY BOOKING",
						"amount": "-27.240"
					},
					{
						"code": "DN",
						"name": "CHILD",
						"amount": "-237.560"
					}],
					"agCommission": "0.00",
					"commissionVAT": "0.00",
					"commissionPCT": "0.00"
				},
				"rooms": 1,
				"adults": 2,
				"children": 2,
				"childrenAges": "8~8"
			}]
		}],
		"totalSellingRate": "413.200",
		"totalNet": "0.000",
		"currency": "EUR"
	}
}

 

Docs Navigation