ARI stands for: Availability, Rates and Inventory. In-effect it means that using this function you can pull Availability, Rates and Restrictions for a specific period (from - to). The bulk method is suitable for most use-cases, and especially if you're holding the data on your end. If you do not store the data on your end, or if you wish to get results per specific stay dates, then you may consider using the immediate method.
The bulk method is most suitable for OTAs and Agencies holding an ARI database, and that need to save long periods of ARI data on their end.
Note: Maximum period for the query: 2 years.
Request
| Element | Attributes | Description | Example |
|---|---|---|---|
| Authentication | username, password | <Authentication username="Test" password="3657488" /> | |
| Authentication | MinimumNights | Use this attribute to get the minimum nights value. Options: YES, NO. If you don't use this attribute then it's like using "NO". | MinimumNights="YES" |
| Hotel | ID | Hotel id="sandbox" | |
| DateRange | from, to | <DateRange from="2015-06-28" to="2015-06-30" /> | |
| Guests | adults, child, babies | <Guests adults="2" child="1" babies="0" /> | |
| Prices | rateCode | rateCode - The rate code provided by the hotel. This field is mandatory and must not be empty. Only one rate code can be requested per call. | Prices rateCode="USD" |
Request Example:
<?xml version="1.0" encoding="UTF-8" ?>
<!-- Mini Hotel - Availability and Rates - Request -->
<AvailRaterq xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Authentication username="Test" password="3657488" ResponseType="05" />
<Hotel id="sandbox" />
<DateRange from="2022-06-20" to="2022-06-30" />
<Prices rateCode="USD">
</Prices>
</AvailRaterq>
Response Example:
<?xml version="1.0" encoding="UTF-8"?>
<AvailRaters>
<Hotel id="sandbox" Name_h="Sandbox Hotel MiniHotel" Currency="USD" />
<DateRange from="2022-01-15" to="2022-01-19" />
<RoomTypes>
<RoomType id="DBL" RoomName="Double Room" BasicOccupancy="002">
<Day Mdate="20220115" Mavailability="4" Mprice="26.10" Minngt="0" Mclose="No" McloseArr="No" McloseDep="No" ExtraAdultFee="22.00" ExtraChildFee="10.00" ExtraBabyFee="7.00" SingleUse="0.00" />
<Day Mdate="20220116" Mavailability="4" Mprice="22.50" Minngt="0" Mclose="No" McloseArr="No" McloseDep="No" ExtraAdultFee="22.00" ExtraChildFee="10.00" ExtraBabyFee="7.00" SingleUse="0.00" />
<Day Mdate="20220117" Mavailability="4" Mprice="22.50" Minngt="0" Mclose="No" McloseArr="No" McloseDep="No" ExtraAdultFee="22.00" ExtraChildFee="10.00" ExtraBabyFee="7.00" SingleUse="0.00" />
<Day Mdate="20220118" Mavailability="4" Mprice="22.50" Minngt="0" Mclose="No" McloseArr="No" McloseDep="No" ExtraAdultFee="22.00" ExtraChildFee="10.00" ExtraBabyFee="7.00" SingleUse="0.00" />
<Day Mdate="20220119" Mavailability="4" Mprice="22.50" Minngt="0" Mclose="No" McloseArr="No" McloseDep="No" ExtraAdultFee="22.00" ExtraChildFee="10.00" ExtraBabyFee="7.00" SingleUse="0.00" />
</RoomType>
<RoomType id="TRP" RoomName="TRIPLE" BasicOccupancy="003">
<Day Mdate="20220115" Mavailability="2" Mprice="27.90" Minngt="0" Mclose="No" McloseArr="No" McloseDep="No" ExtraAdultFee="85.00" ExtraChildFee="50.00" ExtraBabyFee="25.00" SingleUse="0.00" />
<Day Mdate="20220116" Mavailability="2" Mprice="27.90" Minngt="0" Mclose="No" McloseArr="No" McloseDep="No" ExtraAdultFee="85.00" ExtraChildFee="50.00" ExtraBabyFee="25.00" SingleUse="0.00" />
<Day Mdate="20220117" Mavailability="1" Mprice="28.80" Minngt="0" Mclose="No" McloseArr="No" McloseDep="No" ExtraAdultFee="85.00" ExtraChildFee="50.00" ExtraBabyFee="25.00" SingleUse="0.00" />
<Day Mdate="20220118" Mavailability="0" Mprice="28.80" Minngt="0" Mclose="No" McloseArr="No" McloseDep="No" ExtraAdultFee="85.00" ExtraChildFee="50.00" ExtraBabyFee="25.00" SingleUse="0.00" />
<Day Mdate="20220119" Mavailability="0" Mprice="28.80" Minngt="0" Mclose="No" McloseArr="No" McloseDep="No" ExtraAdultFee="85.00" ExtraChildFee="50.00" ExtraBabyFee="25.00" SingleUse="0.00" />
</RoomType>
</RoomTypes>
<Meals>
<Meal MealId="B">
<Day Mdate="20220115" MealAdult="0.00" MealBaby="0.00" MealChild="0.00" />
<Day Mdate="20220116" MealAdult="0.00" MealBaby="0.00" MealChild="0.00" />
<Day Mdate="20220117" MealAdult="0.00" MealBaby="0.00" MealChild="0.00" />
<Day Mdate="20220118" MealAdult="0.00" MealBaby="0.00" MealChild="0.00" />
<Day Mdate="20220119" MealAdult="0.00" MealBaby="0.00" MealChild="0.00" />
</Meal>
</Meals>
</AvailRaters>
Response Explanation:
| Attribute | Description |
|---|---|
| Mavailability | Availability, room quantity available for the date specified |
| Mprice | Price for the date specified |
| Minngt | Minimum Nights for the date specified |
| Mclose | Closure Restriction for the date specified |
| McloseArr | Closure for arrival only, if relevant for the date specified |
| McloseDep | Closure for departure only, if relevant for the date specified |
| ExtraAdultFee | for the date specified |
| ExtraChildFee | for the date specified |
| ExtraBabyFee | for the date specified |
| SingleUse | The reduction from the base price when the room is occupied by one adult only, for the specified date |
| MealId | B = Breakfast; L = Lunch; D = Dinner |