This message is used for sending the following fields:
- Inventory
- Minimum length of stay
- Maximum length of stay
- Minimum length of stay through
- Maximum length of stay through
- Close to arrival
- Close to booking (stop sell)
- Close to departure
- Minimum lead time
- Maximum lead time
Each OTA_HotelAvailNotifRQ message is used to update the inventory and restrictions for a single roomtype for a single rateplan of a single hotel.
Headers
| Header | Value |
|---|---|
| Content-Type | text/xml |
| SOAPAction | OTA_HotelAvailNotifRQ |
XML Description
OTA_HotelAvailNotifRQ
| Parameter | Data Type | Mandatory? | Number of occurrences | Description |
|---|---|---|---|---|
| xmlns | URL | Yes | 1 | - |
| MessageContentCode | Integer | Yes | 1 | - |
| EchoToken | String | Yes | - | |
| TimeStamp | - | Yes | 1 | - |
| Version | - | Yes | 1 | - |
| POS | Object | Yes | 1 | See below |
| AvailStatusMessages | Object | Yes | 1 | Container object for the AvailStatusMessage nodes |
POS
| Parameter | Data Type | Mandatory? | Number of occurrences | Description |
|---|---|---|---|---|
| Source | Object | Yes | 1 | Identifies information related to the eventual point of sale where the end user is making the booking.
For clients selling to the end user, this would be the client reservation confirmation code. For clients selling to other agencies, this should contain the agency's client confirmation code sent to the client API. |
Source
| Parameter | Data Type | Mandatory? | Number of occurrences | Description |
|---|---|---|---|---|
| RequestorID | Object | Yes | 1 | Contains the Demand Client code. |
RequestorID
| Parameter | Data Type | Mandatory? | Number of occurrences | Description |
|---|---|---|---|---|
| Type | Integer | Yes | 1 | - |
| ID | String | Yes | 1 | - |
AvailStatusMessages
| Parameter | Data Type | Mandatory? | Number of occurrences | Description |
|---|---|---|---|---|
| HotelCode | String | Yes | 1 | Unique hotel ID (provided by Hotel Trader). |
| AvailStatusMessage | Object | Yes | 1 - N | Hotel Trader will send availability updates using the AvailStatusMessage.BookingLimit attribute. |
AvailStatusMessage
| Parameter | Data Type | Mandatory? | Number of occurrences | Description |
|---|---|---|---|---|
| BookingLimit | Integer | No | 0 or 1 | This refers to the inventory. The value of BookingLimit will be a non-negative integer. |
| BookingLimitMessageType | String | No | 0 or 1 | Ignore this attribute. This will be deprecated in future releases. |
| StatusApplicationControl | Object | Yes | 1 | The StatusApplicationControl element is used to specify the room type, rate code, and dates for which the update applies. The mandatory Start and End attributes control the dates affected by the update. |
| LengthsOfStay | Object | No | 0 or 1 | Length of stay restrictions are set using this node. |
| RestrictionStatus | Object | No | 0 or 1 | Setting or removing the following restrictions: close to booking (stop sell), close to arrival, close to departure, and lead times. |
StatusApplicationControl
| Parameter | Data Type | Mandatory? | Number of occurrences | Description |
|---|---|---|---|---|
| InvTypeCode | String | Yes | 1 | Unique roomtype code provided by Hotel Trader. |
| RatePlanCode | String | Yes | 1 | Unique rateplan code provided by Hotel Trader. |
| Start | String | Yes | 1 | The start date for this update. The format is YYYY-MM-DD. |
| End | String | Yes | 1 | The end date for this update. The format is YYYY-MM-DD. |
Note - The ARI updates applied by the AvailStatusMessage nodes are inclusive of these start and end dates.
LengthsofStay
| Parameter | Data Type | Mandatory? | Number of occurrences | Description |
|---|---|---|---|---|
| LengthOfStay | Object | Yes | 1 - 4 | Each LengthofStay node corresponds to one of the 4 types of length of stay restrictions. |
LengthOfStay
| Parameter | Data Type | Mandatory? | Number of occurrences | Description |
|---|---|---|---|---|
| MinMaxMessageType | String | Yes | 1 | Possible values:
SetMinLos (refers to the minimum length of stay - arrival-based) SetMaxLos (refers to the maximum length of stay - arrival-based) SetForwardMinStay (refers to minimum length of stay through) SetForwardMaxStay (refers to maximum length of stay through) The default values for MinLOS is 0 and MaxLOS 28. |
| TimeUnit | String | Yes | 1 | Possible values: Day
Indicates that the unit for specified restrictions is in days. |
| Time | Integer | Yes | 1 | The value of the length of stay. This is a non-negative integer. |
For example,
< LengthsOfStay >
< LengthOfStay Time = "3" TimeUnit = "Day" MinMaxMessageType = "SetMinLOS" />
< LengthOfStay Time = "1" TimeUnit = "Day" MinMaxMessageType = "SetForwardMinStay" />
</ LengthsOfStay >
This means that the minimum length of stay (arrival-based) restriction is 3 days and the minimum length of stay through restriction is 1 day.
RestrictionStatus
| Parameter | Data Type | Mandatory? | Number of occurrences | Description |
|---|---|---|---|---|
| Status | String | No | 0 or 1 | Possible values: Open, Close. Restriction and Status attributes should either both be present or both be absent. |
| Restriction | String | No | 0 or 1 | Possible values:
Master (refers to close to booking or stop-sell) Arrival (refers to close to arrival) Departure (refers to close to departure). |
| MinAdvancedBookingOffset | String | No | 0 or 1 | This refers to the minimum lead time (cut-off/advanced purchase period). This can currently be specified only in days. For instance, to specify a minimum lead time of 7 days, the value is set to P7D. |
| MaxAdvancedBookingOffset | String | No | 0 or 1 | This refers to the maximum lead time. This can currently be specified only in days. For instance, to specify a maximum lead time of 999 days, the value is set to P999D. |
Sample OTA_HotelAvailNotifRQ request with all the fields
<OTA_HotelAvailNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" MessageContentCode="3" EchoToken="a-9cahd2-bea0-48cd-a0f0-c3ab1a32b7e1" TimeStamp="2022-07-06T07:24:13.508Z" Version="1.0">
<POS>
<Source>
<RequestorID Type="22" ID="HotelTrader" />
</Source>
</POS>
<AvailStatusMessages HotelCode="TESTHOTELCODE">
<AvailStatusMessage>
<StatusApplicationControl RatePlanCode="HTPKG" Start="2022-07-06" End="2024-02-29" InvTypeCode="KING" />
<RestrictionStatus Restriction="Master" Status="Open" />
</AvailStatusMessage>
<AvailStatusMessage>
<StatusApplicationControl RatePlanCode="HTPKG" Start="2022-07-06" End="2024-02-29" InvTypeCode="KING" />
<RestrictionStatus Restriction="Arrival" Status="Open" />
</AvailStatusMessage>
<AvailStatusMessage>
<StatusApplicationControl RatePlanCode="HTPKG" Start="2022-07-06" End="2024-02-29" InvTypeCode="KING" />
<RestrictionStatus Restriction="Departure" Status="Open" />
</AvailStatusMessage>
<AvailStatusMessage>
<StatusApplicationControl RatePlanCode="HTPKG" Start="2022-07-06" End="2024-02-28" InvTypeCode="KING" />
<LengthsOfStay>
<LengthOfStay Time="1" TimeUnit="Day" MinMaxMessageType="SetMinLOS" />
<LengthOfStay Time="1" TimeUnit="Day" MinMaxMessageType="SetForwardMinStay" />
<LengthOfStay Time="28" TimeUnit="Day" MinMaxMessageType="SetForwardMaxStay" />
<LengthOfStay Time="28" TimeUnit="Day" MinMaxMessageType="SetMaxLOS" />
</LengthsOfStay>
</AvailStatusMessage>
<AvailStatusMessage>
<StatusApplicationControl RatePlanCode="HTPKG" Start="2024-02-29" End="2024-02-29" InvTypeCode="KING" />
<LengthsOfStay>
<LengthOfStay Time="3" TimeUnit="Day" MinMaxMessageType="SetMinLOS" />
</LengthsOfStay>
</AvailStatusMessage>
<AvailStatusMessage>
<StatusApplicationControl RatePlanCode="HTPKG" Start="2022-07-06" End="2024-02-29" InvTypeCode="KING" />
<RestrictionStatus MinAdvancedBookingOffset="P0D" MaxAdvancedBookingOffset="P999D" />
</AvailStatusMessage>
<AvailStatusMessage BookingLimitMessageType="SetLimit" BookingLimit="8">
<StatusApplicationControl RatePlanCode="HTPKG" Start="2022-07-06" End="2022-07-06" InvTypeCode="KING" />
</AvailStatusMessage>
</AvailStatusMessages>
</OTA_HotelAvailNotifRQ>
Sample Response
An OTA_HotelAvailNotifRS object is returned in case of success and errors. See here for more details.