Developer Guide - Restrictions Push API
What is the Push API for restrictions?
Kurzurlaub.de uses the OTA messages OTA_HotelBookingRuleRQ/RS and OTA_HotelBookingRuleRQ/RS,
to receive restrictions and booking rules (sales flags) for a hotel.
The data sent by the OTA partner will only be accepted for rooms that are active and online, alternatively alerts will be sent in response.
Generally, lines with restrictions are considered individually, i.e. an error in the RoomTypeCode or in the date format, the date range is only used for this one Line sent as a warning. All other lines are processed independently.
For example, each message contains a single RuleMessages element that specifies the hotel to be updated using the @HotelCode attribute.
The BookingRule elements contain the updates to be processed over a date range.
A notice:
Multiple BookingRule updates may occur per request, however each request is limited to one hotel (HotelCode) and its rooms and/or offerings.
Two types of availabilities
The first question should always be:
We only use availabilities and restrictions
- room level (RoomType only)
- Room level and/or offer level (RoomType/RatePlan combination)
This also forms the basis of all communication and is determined individually at the beginning for each hotel and each OTA partner.
1. Room level RoomType restrictions
is currently not supported for rules, contact support
2. RoomType/RatePlan based restrictions
If your backend supports room-level and offer-level availability or rates - i.e. room types and rate plans (so-called RoomType/RatePlan combinations), please use this variant.
Example of combination InvTypeCode/RatePlanCode and SetMinLOS/SetMaxLOS as well as Restriction (Arrival, Departure, Master):
<RuleMessage>
<StatusApplicationControl InvTypeCode="12345" RatePlanCode="TEST-BAR-2N"/>
<BookingRules>
<BookingRule Start="2024-05-10" End="2024-05-12">
<LengthsOfStay>
<LengthOfStay MinMaxMessageType="SetMinLOS" Time="2" TimeUnit="Day"/>
<LengthOfStay MinMaxMessageType="SetMaxLOS" Time="7" TimeUnit="Day"/>
</LengthsOfStay>
<RestrictionStatus Restriction="Arrival" Status="Open"/>
<RestrictionStatus Restriction="Departure" Status="Open"/>
<RestrictionStatus Restriction="Master" Status="Close"/>
</BookingRule>
<BookingRule Start="2024-02-15" End="2024-02-15">
<RestrictionStatus Restriction="Arrival" Status="Close"/>
<RestrictionStatus Restriction="Master" Status="Open"/>
</BookingRule>
<BookingRule Start="2024-03-30" End="2024-03-30">
<RestrictionStatus Restriction="Departure" Status="Close"/>
</BookingRule>
</BookingRules>
</RuleMessage>
Overview of available messages
Overview of available messages - official OTA messages - for retrieving/sending restrictions
Read booking rules and restrictions from Kurzurlaub.de
Send booking rules and restrictions to Kurzurlaub.de
See also methods for sending rates and availabilities; restrictions (Master Open/Close, CTA, CTD, MinLOS, MaxLOS) can also be sent here