FAQ

Select category
I don't know where to start, can you provide information to start?
We have an ongoing series of help articles in our blog covering various useful topics in the path of integrating APItude in your system. You can begin at the first entry, where we explain some basic concepts and give some advice about where to start.
What are the response timeouts?

Timeouts for each endpoint are defined at every operation page. Here you can see a compilation of the timeouts:

Operation Timeout (seconds)
Availability 60
CheckRates 60
Booking confirmation 60
BookingList 120
BookingDetails 120
BookingChange 120
BookingCancellation 120
Is there a list of all hotel IDs?
There's no static list of hotels, but you can get them listed in the Hotels operation of the Hotel ContentAPI
Is there a list of all available currencies?
There's no static list of the supported currencies, but you can get them listed in the types/currencies operation of the Hotel ContentAPI
Is there a list of all available languages?
There's no static list of the supported languages, but you can get them listed in the types/languages operation of the Hotel ContentAPI
What's the meaning of the categoryCode values?

The values returned in the categoryCode field are related to the category of the hotel and its rating in stars. For example, a 4EST value means a four stars hotel, a 3EST would mean three stars and so on.

For more information of categoryCode descriptions and categoryCodes descriptions of other accommodation types (such as apart hotels) please check the types/categories operation of the Hotel ContentAPI.

Is there any website where I can verify the results from APItude?
You can cross check APItude's product prices with Hotelopia, Hotelbeds's direct sale channel, but keep in mind that product is not 100% equivalent between the two channels, since there are some providers activated just for APItude that do not appear in Hotelopia's results and vice versa.
The test environment is not working / not returning any results at availability.
Our test environment uptime percentage is 99%, but service shortages can happen from time to time because of multiple reasons like maintenance periods. If the problems persist please contact us.
What's the maximum number of nights I can request?
The number of requested nights must be less than or equal to 30.
What's the maximum number of passengers and rooms I can request?
20 passengers is the maximum of passengers for a non-group, 10 rooms is the maximum number of rooms you can request.
How can I request children?

You must always specify the children in separate pax nodes (child nodes of availabilityRQ/occupancies/occupancy/occupancy/paxes), with the age of each children:

[…]
<occupancies>
	<occupancy rooms="1" adults="1" children="3">
		<paxes>
			<pax type="CH" age="3"/>
			<pax type="CH" age="1"/>
			<pax type="CH" age="1"/>
		</paxes>
	</occupancy>
</occupancies>
[…]
[…]
	"occupancies": [{
		"rooms": 1,
		"adults": 1,
		"children": 3,
		"paxes": [{
			"type": "CH",
			"age": 3
		},
		{
			"type": "CH",
			"age": 1
		},
		{
			"type": "CH",
			"age": 1
		}]
	}],
[…]

Please bear in mind that there's no need to specify the age for adult passengers.

How can I request multiple rooms?

There are two ways to request multiple rooms, using one or the other depends entirely on whether the rooms you are requesting are of the same type or not.

For requesting multiple rooms of the same type and occupancy (with the same distribution and number of passengers):

[…]
	<occupancies>
		<occupancy rooms="2" adults="2" children="2">
			<paxes>
				<pax type="CH" age="5"/>
				<pax type="CH" age="6"/>
			</paxes>
		</occupancy>
	</occupancies>
[…]
[…]
	"occupancies": [{
		"rooms": 2,
		"adults": 2,
		"children": 2,
		"paxes": [
		{
			"type": "CH",
			"age": 5
		},
		{
			"type": "CH",
			"age": 6
		}]
	}],
	}],
[…]

In the examples above 2 rooms are being requested, with 2 adults and 2 children per room, so that would make a request for 8 passengers in total. In this case the CheckRate or the Booking will be performed with just one rateKey.

 

For requesting multiple rooms of different type:

[…]
	<occupancies>
		<occupancy rooms="1" adults="2" children="3">
			<paxes>
				<pax type="CH" age="5"/>
				<pax type="CH" age="6"/>
				<pax type="CH" age="7"/>
			</paxes>
		</occupancy>
		<occupancy rooms="1" adults="2" children="1">
			<paxes>
				<pax type="CH" age="8"/>
			</paxes>
		</occupancy>
	</occupancies>
[…]
[…]
	"occupancies": [{
		"rooms": 1,
		"adults": 2,
		"children": 3,
		"paxes": [
		{
			"type": "CH",
			"age": 5
		},
				{
			"type": "CH",
			"age": 6
		},
				{
			"type": "CH",
			"age": 7
		}]
	},
	{
		"rooms": 1,
		"adults": 2,
		"children": 1,
		"paxes": [
		{
			"type": "CH",
			"age": 8
		}]
	}],
[…]

In this other examples 2 rooms are being requested, one for 2 adults and 3 children and the second for 2 adults and 1 child. That would be a request for 8 passengers as well, but with a different distribution. In this case the CheckRate or the Booking will have to be performed with two rateKeys, one for each occupancy.

What's the rateKey expiration time?
Our rateKeys don't have an expiration time, once you get a rateKey from Availability you can use it in the CheckRate or Booking operations regardless when it was generated, but remember that old rateKeys may have sold out its allotment since its creation time, and therefore it will be impossible to make bookings with them.
It's possible to obtain TripAdvisor® content on Availability?
TripAdvisor ratings must be manually activated in order to be visible at Availability, for more info please get in touch with our support team at apitude@hotelbeds.com.
In the availability response, which one is the price that the customer sees?
In Availability there's no room grouping (as the client is free to pick the rooms and rates best suited for him). To get a total amount the client must calculate it from the rate prices. Those are located in: availabilityRS/hotels/hotel/rooms/room/rates/rate/net.
What's the sourceMarket and what impact has on availability results?

The sourceMarket attribute (set on availabilityRQ/@sourceMarket) is a value to designate the market of the client, and return fares for that market. The value to inform is the country code of the market country. For example if the customer just wants to receive the rates for United Arab Emirates market (country code: "AE"), you should add in your availability the sourceMarket:

<availabilityRQ xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" sourceMarket="AE">
[…]
{
	"sourceMarket": "AE",
[…]

Please bear in mind that this is by no means related to the passenger nationality. You can obtain a list of all the possible values for this attribute with the locations/countries operation of the ContentAPI.

What's the difference between using one set of coordinates with radius and using two sets of coordinates for availability by geolocation?

The difference between them is the shape of the area to be searched.

GPS radial area search

If you use one set of coordinates with radius the search area will be circular, with the center of the circle at your coordinate-designed point and the radius being the one you defined.

[…]
<geolocation latitude="28.532952" longitude="-81.378727" radius="50" unit="km"/>
[…]
[…]
"geolocation": {
	"latitude": 28.532952,
	"longitude": -81.378727,
	"radius": 50,
	"unit": "km"
}
[…]

 

radial
GPS rectangular area search

If you use two set of GPS coordinates, the area to be searched will be rectangular-shaped, with the opposing inferior left and upper right vertices as the points you defined as primary and secondary coordinates.

[…]
<geolocation latitude="28.457054" longitude="-81.481377" secondaryLatitude="28.621938" secondaryLongitude="-81.257486"/>						
[…]
[…]
"geolocation": {
	"latitude": 28.457054,
	"longitude": -81.481377,
	"secondaryLatitude": 28.621938,
	"secondaryLongitude": -81.257486.
}
[…]

 

rectangular
What's max number of rateKeys per request in CheckRates operation?
The room limitation would limit this to 10 rateKeys, as even with different rooms (and consequently different rateKeys) no booking can have more than 10 rooms.
What's the format for a multi room CheckRates request?
You can see examples in the CheckRates operation section and in the Postman collection
Can a multi room CheckRates request contain rateKeys from different hotels?
No, only one hotel is allowed per request.
It is possible to book two rates with different payment types, one AT_HOTEL, and other AT_WEB?
No, you combine rates with payment type AT_HOTEL and AT_WEB.
It is mandatory to inform all the passenger names at confirmation step?
Yes, it's mandatory to inform names and surnames for all passengers, as well as the reservation holder name and surname.
It is possible to use special characters (ç, ã, á, ä Å, Â, å, é, ü, î, Ø, ö, ñ, ƒ, æ, ß) when informing names (both holder and passenger)?
Yes, as long as the UTF-8 codification is used.
It is possible to pass requests/remarks as free text via "remark" field?
Yes, the text introduced in the "remark" field will be passed to the hotel, but please take into account that the fulfillment of any request made here depends completely on the hotel and its personnel, and as such the capacity to comply might be limited to the circumstances and capabilities of each hotel.
What's the maximum number of characters I can send as freetext in the "remark" field?
2000 characters is the maximum of characters you can send in the "remark" field.
I'm having difficulties to successfully book multiple rooms of the same type.

To book multiple rooms of the same type you just have to add the additional pax elements while increasing the roomId attribute for the passengers of each subsequent room. This is done to assign this extra passengers (for which there would normally be no space) to additional rooms of the same type.

You can find a detailed explanation and examples in the booking section. If you need more examples or have additional doubts contact our support team.

How can I perform a multi room cancellation?
The cancellation of a booking is performed the same way independently of the booking's number of rooms.
Why do I receive the cancellation details when canceling a booking?
Cancellation operation response is formated as a details operation response as a mean to give detailed information of the booking once has been canceled and to let our clients verify that the booking has been indeed canceled.

Can't find the answer you need? Don't hesitate to contact us!

Docs Navigation