Inventory
The HotelRatePlanInventoryNotif
message contains information about the inventory setup that is followed by the structure: Hotel > Rate Plan > Room.
As explained before, Channel-X extracts the product loaded between the Buyer (inventory) and the Channel Managers (availability and rates) into our Inventory tool and sends it to the Buyer's system, to your system. So, in this case, Travelgate will send HotelRatePlanInventoryNotif
requests to your system, and you will respond with either success or error.
HotelRatePlanInventoryNotif Request
In the following examples, you will observe the requests that Travelgate will send you. All the examples presented here are Deltas (smaller product requests).
If you want to explore all possible scenarios of information that may come your way, head over to More Request Examples section; there you will find Full Copy (full product details requests) examples.
- Inventory
- Derived RatePlan
- Offers
<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">
<o:UsernameToken u:Id = "uuid-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx-x">
<o:Username>username</o:Username>
<o:Password Type = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</o:Password>
</o:UsernameToken>
</o:Security>
</s:Header>
<s:Body xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd = "http://www.w3.org/2001/XMLSchema">
<HotelRatePlanInventoryNotif xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.xmltravelgate.com/hubpush/provider/2012/10">
<request Version="0">
<POS xmlns="http://www.opentravel.org/OTA/2003/05">
<Source>
<RequestorID ID="Seller Code" />
<BookingChannel>
<CompanyName Code="Buyer Code" />
</BookingChannel>
</Source>
</POS>
<RatePlans HotelStatusType="Active" HotelCode="2" xmlns="http://www.opentravel.org/OTA/2003/05">
<RatePlan Start="2023-11-08" End="2023-11-25" CurrencyCode="EUR" PromotionCode="25" RatePlanType="0" RatePlanCode="BAR" RateReturn="false" FreeChild="false" FreeBaby="false" RatePlanNotifType="Delta" RatePlanStatusType="Active" YieldableIndicator="false">
<BookingRules>
<BookingRule>
<CancelPenalties>
<CancelPenalty NonRefundable="false" />
<CancelPenalty Start="2023-10-09" End="2023-10-09">
<Deadline OffsetTimeUnit="Day" OffsetUnitMultiplier="2" OffsetDropTime="BeforeArrival" />
<AmountPercent Amount="10" />
</CancelPenalty>
</CancelPenalties>
<Viewerships>
<Viewership>
<LocationCodes LocationCodesInclusive="false">
<LocationCode CountryCode="ES" />
</LocationCodes>
</Viewership>
</Viewerships>
</BookingRule>
</BookingRules>
<Rates>
<Rate>
<AdditionalGuestAmounts>
<AdditionalGuestAmount AgeQualifyingCode="8" MaxAge="12" />
<AdditionalGuestAmount AgeQualifyingCode="7" MaxAge="2" />
</AdditionalGuestAmounts>
<PaymentPolicies>
<GuaranteePayment PaymentCode="DirectPayment">
<AcceptedPayments>
<AcceptedPayment>
<PaymentCard CardCode="VI">
<IsVCC>false</IsVCC>
</PaymentCard>
</AcceptedPayment>
<AcceptedPayment>
<PaymentCard CardCode="CA">
<IsVCC>false</IsVCC>
</PaymentCard>
</AcceptedPayment>
</AcceptedPayments>
</GuaranteePayment>
</PaymentPolicies>
<MealsIncluded MealPlanCodes="14" />
</Rate>
</Rates>
<SellableProducts>
<SellableProduct InvCode="SNG" InvType="ROOM" InvNotifType="New" InvStatusType="Active" InvTypeCode="1234">
<GuestRoom>
<Quantities StandardNumBeds="2" />
<Occupancy MinOccupancy="2" MaxOccupancy="2" AgeQualifyingCode="10" />
<Room RoomTypeCode="SNG" />
<Description>
<Text>Single Room Test</Text>
</Description>
</GuestRoom>
</SellableProduct>
</SellableProducts>
<Commission Percent="20" />
<Description>
<Text>BAR</Text>
</Description>
<Taxes>
<Tax Percent="10" ChargeUnit="false" ChargeFrequency="false" Type="Inclusive">
<TaxDescription>
<Text>city</Text>
</TaxDescription>
</Tax>
</Taxes>
<AdditionalDetails>
<AdditionalDetail Code="hola" Type="39">
<DetailDescription>
<Text>hola</Text>
</DetailDescription>
</AdditionalDetail>
</AdditionalDetails>
</RatePlan>
</RatePlans>
</request>
</HotelRatePlanInventoryNotif>
</s:Body>
</s:Envelope>
<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">
<o:UsernameToken u:Id = "uuid-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx-x">
<o:Username>username</o:Username>
<o:Password Type = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</o:Password>
</o:UsernameToken>
</o:Security>
</s:Header>
<s:Body xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd = "http://www.w3.org/2001/XMLSchema">
<HotelRatePlanInventoryNotif xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.xmltravelgate.com/hubpush/provider/2012/10">
<request Version="0">
<POS xmlns="http://www.opentravel.org/OTA/2003/05">
<Source>
<RequestorID ID="Seller Code" />
<BookingChannel>
<CompanyName Code="Buyer Code" />
</BookingChannel>
</Source>
</POS>
<RatePlans HotelStatusType="Active" HotelCode="2" xmlns="http://www.opentravel.org/OTA/2003/05">
<RatePlan Start="2023-11-08" End="2023-11-25" RatePlanType="10" RatePlanCode="BDER" RateReturn="true" FreeChild="false" FreeBaby="false" RatePlanNotifType="Delta" RatePlanStatusType="Active" BaseRatePlanCode="BAR">
<BookingRules>
<BookingRule>
<CancelPenalties>
<CancelPenalty>
<Deadline OffsetTimeUnit="Day" OffsetUnitMultiplier="3" OffsetDropTime="BeforeArrival" />
<AmountPercent Percent="50" />
</CancelPenalty>
</CancelPenalties>
<Viewerships>
<Viewership>
<LocationCodes LocationCodesInclusive="true">
<LocationCode CountryCode="BG" />
</LocationCodes>
</Viewership>
</Viewerships>
</BookingRule>
</BookingRules>
<Rates>
<Rate>
<PaymentPolicies>
<GuaranteePayment PaymentCode="BookingDatePayment">
<AcceptedPayments>
<AcceptedPayment>
<PaymentCard CardCode="VI">
<IsVCC>false</IsVCC>
</PaymentCard>
</AcceptedPayment>
<AcceptedPayment>
<PaymentCard CardCode="AX">
<IsVCC>false</IsVCC>
</PaymentCard>
</AcceptedPayment>
</AcceptedPayments>
</GuaranteePayment>
</PaymentPolicies>
<MealsIncluded MealPlanCodes="14" />
</Rate>
</Rates>
<SellableProducts>
<SellableProduct InvCode="DRT1" InvType="ROOM" />
</SellableProducts>
<Description>
<Text>Bar Derived</Text>
</Description>
<AdditionalDetails>
<AdditionalDetail Code="SC" Type="39">
<DetailDescription>
<Text>Specific Client</Text>
</DetailDescription>
</AdditionalDetail>
</AdditionalDetails>
</RatePlan>
</RatePlans>
</request>
</HotelRatePlanInventoryNotif>
</s:Body>
</s:Envelope>
<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">
<o:UsernameToken u:Id = "uuid-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx-x">
<o:Username>username</o:Username>
<o:Password Type = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</o:Password>
</o:UsernameToken>
</o:Security>
</s:Header>
<s:Body xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd = "http://www.w3.org/2001/XMLSchema">
<HotelRatePlanInventoryNotif xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.xmltravelgate.com/hubpush/provider/2012/10">
<request Version="0">
<POS xmlns="http://www.opentravel.org/OTA/2003/05">
<Source>
<RequestorID ID="Seller Code" />
<BookingChannel>
<CompanyName Code="Buyer Code" />
</BookingChannel>
</Source>
</POS>
<RatePlans HotelStatusType="Active" HotelCode="2" xmlns="http://www.opentravel.org/OTA/2003/05">
<RatePlan Start="2023-11-13" End="2023-11-30" RatePlanCode="PCK" RateReturn="false" FreeChild="false" FreeBaby="false" RatePlanStatusType="Active">
<Offers>
<Offer OfferCode="OFFER" OfferStatusType="Active" OfferNotifType="New">
<OfferRules>
<OfferRule>
<DOW_Restrictions>
<AvailableDaysOfWeek Mon="true" Tue="true" Weds="false" Thur="true" Fri="false" Sat="true" Sun="true" />
</DOW_Restrictions>
</OfferRule>
<OfferRule>
<Inventories>
<Inventory InvCode="1BDAPT" />
</Inventories>
</OfferRule>
<OfferRule>
<LengthsOfStay>
<LengthOfStay Time="2" MinMaxMessageType="MinLOS" />
<LengthOfStay Time="5" MinMaxMessageType="MaxLOS" />
</LengthsOfStay>
</OfferRule>
</OfferRules>
<Discount NightsDiscounted="1" DiscountPattern="Cheapest" />
<OfferDescription>
<Text>SUPER OFFER</Text>
</OfferDescription>
</Offer>
</Offers>
</RatePlan>
</RatePlans>
</request>
</HotelRatePlanInventoryNotif>
</s:Body>
</s:Envelope>
Request Data Breakdown
Element | Rel | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
HotelRatePlanInventoryNotif | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HotelRatePlanInventoryNotif/request | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
request/RatePlans | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@HotelStatusType | 1 | String | Active or Deactivated | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@HotelCode | 1 | String | Hotel code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RatePlans/RatePlan | 0..n | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@Start | 0..1 | Date | The start date when the product associated with the rate plan becomes available for booking. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@End | 0..1 | Date | The end date when booking for the product associated with the rate plan is no longer available. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@CurrencyCode | 0..1 | String | ISO Currency. This field is exclusively used for Basic Rates. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@PromotionCode | 0..1 | String | Senior Rates Codes
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@RatePlanType | 0..1 | String | Rate Rule Codes
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@RatePlanCode | 1 | String | Rate code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@RateReturn | 0..1 | Boolean | If true, the base rate will be provided to the channel instead of the derived one. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@FreeChild | 1 | Boolean | Indicates if childern are free with this rate plan. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@FreeBaby | 1 | Boolean | Indicates if babies are free with this rate plan. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@RatePlanNotifType | 0..1 | String | New , Delta or Remove | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@RatePlanStatusType | 1 | String | Active or Deactivated | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@YieldableIndicator | 0..1 | Boolean | If true or it's not returned, the product can be sold below the price. If false, the product cannot be sold below the price. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@BaseRatePlanCode | 0..1 | String | Base rate plan code. This field is exclusively used for Derivated Rates, so if this field appears, the @RatePlanCode will always be 'DERIVED'. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RatePlan/BookingRules | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BookingRules/BookingRule | 1..n | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@Code | 0..1 | String | Empty if there are viewerships conditions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BookingRule/CancelPenalties | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CancelPenalties/CancelPenalty | 1..n | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@NonRefundable | 1 | Boolean | Indicates if a rate is non refundable (true) or refundable (false). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@Start | 0..1 | Date | The start date when the cancellation policies will come into effect. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@End | 0..1 | Date | The end date when the cancellation policies will cease to be in effect. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CancelPenalty/Deadline | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@OffsetTimeUnit | 1 | String | Day | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@OffsetUnitMultiplier | 1 | Integer | Number of days before check-in. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@OffsetDropTime | 1 | String | BeforeArrival | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CancelPenalty/AmountPercent | 1 | Only one option will be returned (@NmbrOfNights, @Percent or @Amount). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@NmbrOfNights | 0..1 | Integer | Number of nights that will be charged. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@Percent | 0..1 | Decimal | The percentage of the total amount that will be charged in the event of cancellation, in accordance with the current cancellation penalty. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@Amount | 0..1 | Decimal | Amount that will be charged. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@CurrencyCode | 0..1 | String | ISO Currency. If the @Amount tag is included, the @CurrencyCode must also be present. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BookingRule/Viewerships | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Viewerships/Viewership | 1..n | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Viewership/LocationCodes | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@LocationCodesInclusive | 1 | Boolean | Can or cannot be requested from this @CountryCode. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/LocationCode | 0..1 | If it is missing, applies to all @CountryCode. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@CountryCode | 1 | String | Country ISO2 code. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RatePlan/Rates | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Rates/Rate | 1..n | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Rate/AdditionalGuestAmounts | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AdditionalGuestAmounts/AdditionalGuestAmount | 1..2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@AgeQualifyingCode | 1 | Integer | Age Qualifying Codes
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@MaxAge | 1 | Integer | Max age of the additional guest. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Rate/PaymentPolicies | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PaymentPolicies/GuaranteePayment | 1..n | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@PaymentCode | 1 | Integer | Payment Type Codes
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GuaranteePayment/AcceptedPayments | 0..1 | Only present if @PaymentCode is not 'MerchantPayment'. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AcceptedPayments/AcceptedPayment | 1..n | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AcceptedPayment/PaymentCard | 1..n | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@CardCode | 1 | String | Credit Card codes
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PaymentCard/IsVCC | 1 | Boolean | Indicates if the card is a Virtual Credit Card. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Rate/MealsIncluded | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@MealPlanCodes | 1 | Integer | Meal Plan codes
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RatePlan/SellableProducts | 0..1 | Room list. If no rooms are listed and it's a derived rate, it will apply to all rooms; otherwise, it will only apply to the listed rooms. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SellableProducts/SellableProduct | 0..n | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@InvCode | 1 | String | Room code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@InvType | 1 | String | ROOM | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@InvNotifType | 0..1 | String | New , Delta or Remove | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@InvStatusType | 1 | String | Active or Deactivated | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@InvTypeCode | 0..1 | String | External information about the room (own code, own description, etc.). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SellableProduct/GuestRoom | 1..n | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GuestRoom/Quantities | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@StandardNumBeds | 1 | Integer | Standard occupation of the room. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GuestRoom/Occupancy | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@MinOccupancy | 1 | Integer | Minimum occupancy | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@MaxOccupancy | 1 | Integer | Maximum occupancy | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@AgeQualifyingCode | 1 | Integer | Age Qualifying Codes
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GuestRoom/Room | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@RoomTypeCode | 1 | String | Room code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GuestRoom/Description | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description/Text | 1 | String | Room description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RatePlan/Commission | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@Percent | 1 | Decimal | Commission percentage applied. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RatePlan/Description | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description/Text | 1 | String | Rate description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RatePlan/Taxes | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Taxes/Tax | 1..n | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@Amount/Percent | 1 | Decimal | Tax will be applied relative to an amount or a percentage. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@ChargeUnit | 0..1 | Boolean | Tax is applied or not based on the amount of paxes booked. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@ChargeFrequency | 0..1 | Boolean | Tax is applied or not based on the number of nights booked. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@Type | 0..1 | String | If Inclusive is indicated, it means that tax must be added to the final price. If the type is different from Inclusive or is not present, the tax is for informational purposes only. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Tax/TaxDescription | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TaxDescription/Text | 1 | String | Tax description, tax type. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RatePlan/AdditionalDetails | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AdditionalDetails/AdditionalDetail | 0..n | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@Code | 1 | String | Client code for whom the rate is offered. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@Type | 1 | String | Contract/negotiated booking information, allowed only for 39 . | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AdditionalDetail/DetailDescription | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DetailDescription/Text | 1 | String | If the additional details type is 39 , the name of the client for whom the rate is offered will be sent as text. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RatePlan/Offers | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Offers/Offer | 1..n | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@OfferCode | 1 | String | Offer code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@OfferStatusType | 1 | String | Active or Deactivated | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@OfferNotifType | 0..1 | String | New , Delta or Remove | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Offer/OfferRules | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OfferRules/OfferRule | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OfferRule/DOW_Restrictions | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DOW_Restrictions/AvailableDaysOfWeek | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@Mon | 1 | Boolean | If true the offer data applies on Monday. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@Tue | 1 | Boolean | If true the offer data applies on Tuesday. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@Weds | 1 | Boolean | If true the offer data applies on Wednesday. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@Thur | 1 | Boolean | If true the offer data applies on Thursday. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@Fri | 1 | Boolean | If true the offer data applies on Friday. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@Sat | 1 | Boolean | If true the offer data applies on Saturday. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@Sun | 1 | Boolean | If true the offer data applies on Sunday. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OfferRule/Inventories | 0..1 | If no Inventories are sent, the offer will apply to all the rooms in the rate. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Intentories/Inventory | 1..n | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@InvCode | 1 | String | Room code to which the offer will apply. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OfferRule/LengthsOfStay | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LengthsOfStay/LengthOfStay | 1..2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@Time | 1 | Integer | It indicates the number of nights for this stay. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@MinMaxMessageType | 1 | String | MinLOS (minimum) or MaxLOS (maximum) @LenghtOfStay for the @Offer. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Offer/Discount | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@NightsDiscounted | 1 | String | Nights discounted by the offer from the total stay amount. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@DiscountPattern | 1 | String | First , Last or Cheapest . Booking night(s) the offer will dicount. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Offer/OfferDescription | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OfferDescription/Text | 1 | String | Offer description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
request/TPA_Extensions | 0..1 | Only added when a FullCopy or when creating, modifying or deleting a hotel. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TPA_Extensions/Attribute | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@key | 1 | String | HotelNotifType | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@value | 1 | String | FullCopy , New , Delta or Remove |
More Request Examples
Download the following requests to explore all possible scenarios of information that may come your way.
HotelRatePlanInventoryNotif Response
After each request, a response should be provided from yours side. If a HotelRatePlanInventoryNotif
request is received, a corresponding HotelRatePlanInventoryNotif
response should be sent. There are two response options, success or error.
Our system has a timeout of 5000ms. If no response occurs within this timeframe, we won't attempt to resend the request. It is recommended that your system processes our requests with an average handling time of 100ms.
- Success
- 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" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<s:Header>
<wsse:Security>
<U:Timestamp>
<U:Created>2023-11-10T11:16:19.206</U:Created>
<U:Expires>2023-11-10T11:46:19.206</U:Expires>
</U:Timestamp>
</wsse:Security>
</s:Header>
<s:Body>
<HotelRatePlanInventoryNotifResponse xmlns="http://schemas.xmltravelgate.com/hubpush/provider/2012/10">
<HotelRatePlanInventoryNotifResult Version="0" TransactionIdentifier="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx">
<Success xmlns="http://www.opentravel.org/OTA/2003/05" />
</HotelRatePlanInventoryNotifResult>
</HotelRatePlanInventoryNotifResponse>
</s:Body>
</s:Envelope>
<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" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<s:Header>
<wsse:Security>
<U:Timestamp>
<U:Created>2023-11-10T11:15:37.445</U:Created>
<U:Expires>2023-11-10T11:45:37.445</U:Expires>
</U:Timestamp>
</wsse:Security>
</s:Header>
<s:Body>
<HotelRatePlanInventoryNotifResponse xmlns="http://schemas.xmltravelgate.com/hubpush/provider/2012/10">
<HotelRatePlanInventoryNotifResult Version="0" TransactionIdentifier="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx">
<Errors xmlns="http://www.opentravel.org/OTA/2003/05">
<Error ShortText="Validation error" Code="-1" Language="en"/>
</Errors>
</HotelRatePlanInventoryNotifResult>
</HotelRatePlanInventoryNotifResponse>
</s:Body>
</s:Envelope>
Response Data Breakdown
Element | Rel | Type | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
HotelRatePlanInventoryNotifResult | 1 | ||||||||||||||||||||||
@Version | 1 | String | 0 | ||||||||||||||||||||
@TransactionIdentifier | 1 | String | Transaction Identifier | ||||||||||||||||||||
HotelRatePlanInventoryNotifResult/Success | 0..1 | If SUCESS | |||||||||||||||||||||
HotelRatePlanInventoryNotifResult/Errors | 0..1 | If ERROR | |||||||||||||||||||||
Errors/Error | 1 | ||||||||||||||||||||||
@ShortText | 1 | String | Error Codes and Description
| ||||||||||||||||||||
@Code | 1 | String | Error Codes and Description
| ||||||||||||||||||||
@Language | 1 | String | Language Codes
|
Frequently Asked Questions
How do I know whether it is a Full Copy or a Delta?
What does New, Delta and Remove mean?
How can I determine if a rate is a Derived Rate?
To find out if a rate is derived, you should check if the BaseRatePlanCode element is present in the RatePlan node. If it is, then it is a derived rate, which will also be indicated in the Description node.
Go to the Requests section and select Derived RatePlan; you will see that both nodes are underscored.
What happens if a rate is deleted, does Travelgate inform us of this in the Full Copy?
In an offer (or derived rate) what does it signify if no rooms are specified or mentioned?
If no rooms are specified in an offer or derived rate, it indicates that the offer or derived rate applies to all rooms.