Skip to main content

Availability Push

The HotelAvailNotif request message pushes availabilities for the inventory that has been previously setup.

HotelAvailNotif Request​

In the following examples, you will see the requests that you need to send in order to Push Availability.

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://www.opentravel.org/OTA/2003/05" xmlns:ns2="http://schemas.xmltravelgate.com/hubpush/provider/2012/10" xmlns:ns3="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<SOAP-ENV:Header>
<ns3:Security SOAP-ENV:mustUnderstand="1">
<ns3:UsernameToken>
<ns3:Username>username</ns3:Username>
<ns3:Password>password</ns3:Password>
</ns3:UsernameToken>
</ns3:Security>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<ns2:HotelAvailNotif>
<ns2:request>
<ns1:POS>
<ns1:Source>
<ns1:RequestorID ID="Seller Code"/>
<ns1:BookingChannel>
<ns1:CompanyName Code="Buyer Code"/>
</ns1:BookingChannel>
</ns1:Source>
</ns1:POS>
<ns1:AvailStatusMessages HotelCode="2">
<ns1:AvailStatusMessage BookingLimit="13">
<ns1:StatusApplicationControl Start="2023-12-20" End="2023-12-22" PromotionCode = "25" RatePlanCode="BAR" Mon="true" Tue="true" Weds="true" Thur="true" Fri="true" Sat="true" Sun="true"/>
</ns1:AvailStatusMessage>
<ns1:AvailStatusMessage>
<ns1:StatusApplicationControl Start="2023-12-20" End="2023-12-22" RatePlanCode="BAR" InvCode="STD3" Mon="true" Tue="true" Weds="true" Thur="true" Fri="true" Sat="true" Sun="true"/>
<ns1:LengthsOfStay>
<ns1:LengthOfStay Time="1" TimeUnit="Day" MinMaxMessageType="MinLOS"/>
<ns1:LengthOfStay Time="28" TimeUnit="Day" MinMaxMessageType="MaxLOS"/>
</ns1:LengthsOfStay>
<ns1:RestrictionStatus Restriction="Master" Status="Open"/>
</ns1:AvailStatusMessage>
<ns1:AvailStatusMessage>
<ns1:StatusApplicationControl Start="2023-12-20" End="2023-12-22" RatePlanCode="BAR" InvCode="STD3" Mon="true" Tue="true" Weds="true" Thur="true" Fri="true" Sat="true" Sun="true"/>
<ns1:RestrictionStatus Restriction="Arrival" Status="Open"/>
</ns1:AvailStatusMessage>
<ns1:AvailStatusMessage>
<ns1:StatusApplicationControl Start="2023-12-20" End="2023-12-22" RatePlanCode="BAR" InvCode="STD3" Mon="true" Tue="true" Weds="true" Thur="true" Fri="true" Sat="true" Sun="true"/>
<ns1:RestrictionStatus Restriction="Departure" Status="Open"/>
</ns1:AvailStatusMessage>
<ns1:AvailStatusMessage>
<ns1:StatusApplicationControl Start="2023-12-20" End="2023-12-22" RatePlanCode="BAR" InvCode="STD3" Mon="true" Tue="true" Weds="true" Thur="true" Fri="true" Sat="true" Sun="true"/>
<ns1:RestrictionStatus SellThroughOpenIndicator="false" MaxAdvancedBookingOffset="2" MinAdvancedBookingOffset="1"/>
</ns1:AvailStatusMessage>
<ns1:AvailStatusMessage BookingLimit="14">
<ns1:StatusApplicationControl Start="2023-12-20" End="2023-12-22" RatePlanCode="BAR" InvCode="STD3" Mon="true" Tue="true" Weds="true" Thur="true" Fri="true" Sat="true" Sun="true"/>
</ns1:AvailStatusMessage>
<ns1:AvailStatusMessage>
<ns1:StatusApplicationControl Start="2023-12-20" End="2023-12-22" RatePlanCode="BAR" InvCode="STD3" Mon="true" Tue="true" Weds="true" Thur="true" Fri="true" Sat="true" Sun="true"/>
<ns1:LengthsOfStay>
<ns1:LengthOfStay Time="1" TimeUnit="Day" MinMaxMessageType="MinLOS"/>
<ns1:LengthOfStay Time="28" TimeUnit="Day" MinMaxMessageType="MaxLOS"/>
</ns1:LengthsOfStay>
<ns1:RestrictionStatus Restriction="Master" Status="Open"/>
</ns1:AvailStatusMessage>
<ns1:AvailStatusMessage>
<ns1:StatusApplicationControl Start="2023-12-20" End="2023-12-22" RatePlanCode="BAR" InvCode="STD3" Mon="true" Tue="true" Weds="true" Thur="true" Fri="true" Sat="true" Sun="true"/>
<ns1:RestrictionStatus Restriction="Arrival" Status="Open"/>
</ns1:AvailStatusMessage>
<ns1:AvailStatusMessage>
<ns1:StatusApplicationControl Start="2023-12-20" End="2023-12-22" RatePlanCode="BAR" InvCode="STD3" Mon="true" Tue="true" Weds="true" Thur="true" Fri="true" Sat="true" Sun="true"/>
<ns1:RestrictionStatus Restriction="Departure" Status="Open"/>
</ns1:AvailStatusMessage>
<ns1:AvailStatusMessage>
<ns1:StatusApplicationControl Start="2023-12-20" End="2023-12-22" RatePlanCode="BAR" InvCode="STD3" Mon="true" Tue="true" Weds="true" Thur="true" Fri="true" Sat="true" Sun="true"/>
<ns1:RestrictionStatus SellThroughOpenIndicator="false" MaxAdvancedBookingOffset="2" MinAdvancedBookingOffset="1"/>
</ns1:AvailStatusMessage>
</ns1:AvailStatusMessages>
</ns2:request>
</ns2:HotelAvailNotif>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Request Data Breakdown​

note

During the onboarding process, your username and password will be provided. After each connection is established, you'll receive an email with RequestorID (Seller Code) and CompanyName (Buyer Code) values.

ElementRelTypeDescription
HotelAvailNotif1
HotelAvailNotif/request1
request/AvailStatusMessages1
@HotelCode1StringHotel code
AvailStatusMessages/AvailStatusMessage1..n
@BookingLimit0..1IntegerThe number of rooms available per Room-RatePlan for the specified dates. In the case of Derived Rates this element will not be returned.
@BookingSold0..1IntegerThe number of rooms booked per Room-RatePlan for the specified dates. The available allotment is calculated as the difference between @BookingLimit and @BookingSold.
AvailStatusMessage/StatusApplicationControl1
@Start1DateStart date
@End1DateEnd date
@RatePlanCode1String
@InvCode0..1StringRoom code. This field is exclusively used for Basic Rates.
@InvType0..1StringROOM. This field is exclusively used for Basic Rates.
@PromotionCode0..1StringOfferCode. This field is exclusively used for Offers.
@Mon0..1BooleanIf true or attribute is not present, there is availability on Monday.
@Tue0..1BooleanIf true or attribute is not present, there is availability on Tuesday.
@Weds0..1BooleanIf true or attribute is not present, there is availability on Wednesday.
@Thur0..1BooleanIf true or attribute is not present, there is availability on Thursday.
@Fri0..1BooleanIf true or attribute is not present, there is availability on Friday.
@Sat0..1BooleanIf true or attribute is not present, there is availability on Saturday.
@Sat0..1BooleanIf true or attribute is not present, there is availability on Sunday.
AvailStatusMessage/LengthsOfStay0..1
@ArrivalDateBased0..1BooleanIf true, the Minimum and Maximum Stay is checked ONLY the first day of the availability. If false or null, the Minimum and Maximum Stay is checked all the availability days. If both values are needed, two @AvailStatusMessage will be sent.
LengthsOfStay/LengthOfStay1..2
@Time1IntegerIndicates the number of @TimeUnit for this stay. When value is 0 or -1, condition should be deleted from the system.
@TimeUnit1StringDay
@MinMaxMessageType1StringMinLOS (minimum) or MaxLOS (maximum) @LenghtOfSaty.
AvailStatusMessage/RestrictionStatus0..1
@Restriction0..1StringMaster, Arrival or Departure
@Status0..1StringOpen or Close
@MinAdvancedBookingOffset0..1IntegerMinimum number of days before the check-in date to be available to be booked. This restriction is usually used to offer discounts on early bookings. When value is 0 or -1, condition should be deleted from the system.
@MaxAdvancedBookingOffset0..1IntegerMaximum number of days before the check-in date to be available to be booked. This restriction is usually used to offer last minute discounts on unsold inventory. When value is -1, condition should be deleted from the system.
@SellThroughOpenIndicator0..1BooleanRoom-RatePlan can be sold with no limit if @Status is 'Open'. This field is exclusively used for Basic Rates.

HotelAvailNotif Response​

After each request, Travelgate will process the data and provide you with a response. Upon receiving a HotelAvailNotif request, Travelgate will send you a corresponding HotelAvailNotif response. The response options include either success or an error.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<s:Header>
<o:Security s:mustUnderstand="1" xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<u:Timestamp u:Id="_0">
<u:Created>2023-11-22T11:03:26.904Z</u:Created>
<u:Expires>2023-11-22T11:08:26.904Z</u:Expires>
</u:Timestamp>
</o:Security>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<HotelAvailNotifResultResponse xmlns="http://schemas.xmltravelgate.com/hubpush/provider/2012/10">
<HotelAvailNotifResultResult>
<Success xmlns="http://www.opentravel.org/OTA/2003/05"/>
</HotelAvailNotifResultResult>
</HotelAvailNotifResultResponse>
</s:Body>
</s:Envelope>

Response Data Breakdown​

ElementRelTypeDescription
HotelAvailNotifResult1
HotelAvailNotifResult/Success0..1If SUCESS
HotelAvailNotifResult/Errors0..1If ERROR
Errors/Error1
@Code1StringError code. TravelGate defines the standardized codes listed below; when the Seller's own system returns a code, it is forwarded as-is (so you may occasionally receive codes outside this list, e.g. 361).
@Type0..1StringOTA Error Warning Type (EWT) categorizing the error. Optional: it appears only when the responding system provides it (TravelGate-generated errors omit it).
@ShortText1StringShort, standardized label of the error.
Error (text)0..1StringDetailed, human-readable description of the error.
Error structure

When the Seller has implemented the Push API, its system returns the error following the OTA standard: @Code, an optional @Type, @ShortText and a descriptive body. When the Seller has not implemented it, TravelGate standardizes the response using the error codes below (without @Type). This is why you may occasionally receive a @Code outside the standardized list (e.g. 361), forwarded from the Seller's own system.

Error codes
Error CodeShortText
-1Unexpected error
1Invalid request
10Invalid hotel id
11Invalid dates
12Invalid rate plan code
13Invalid reservation id
14Invalid derived rate adjust values
15Invalid id
16Invalid amount type
17Invalid supplement type
18Invalid number of hotel
19Invalid rate currency code
20Requestor id not found
21Provider id not found
22Rooms not found
23Rates not found
30Occupation error
31Rate error
32Avail rq error
33Data Base error
37Authorization error
38Authentication error
90Connection time out