Inventory Retrieval

The HotelRatePlanInventoryRetrieve request message is sent to retrieve a list of Hotels > Rate Plans > Rooms, along with their configurations.

HotelRatePlanInventoryRetrieve Request

caution

Inactive rate plans and rooms will not be returned in this message.

<Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.xmlsoap.org/soap/envelope/">
   <Header>
      <o:Security xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <o:UsernameToken Id="xnExysS120i8nwXu90DOToFTjoyuWpFe">
            <o:Username>username</o:Username>
            <o:Password>password</o:Password>
         </o:UsernameToken>
      </o:Security>
   </Header>
   <Body>
      <HotelRatePlanInventoryRetrieve 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 xmlns="http://www.opentravel.org/OTA/2003/05">
               <RatePlan>
                  <HotelRef HotelCode="2"/>
               </RatePlan>
            </RatePlans>
         </request>
      </HotelRatePlanInventoryRetrieve>
   </Body>
</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.

Element	Rel	Type	Description
HotelRatePlanInventoryRetrieve	1
request	1
request/POS	1
POS/Source	1
Source/TPA_Extensions	0..1		Optional, if empty only active inventory will be received
TPA_Extensions/Params	0..1
Params/Param	0..N
@key	1	String	`onlyActive`
@value	1	String	1 - You will receive all active inventory data. 0 - Active and deactivated inventory will be received. (Same case as without TPA_Extensions node.)
RatePlans	0..1		Contains hotel filter
request/RatePlan	0..1
RatePlan/HotelRef	0..1
@HotelCode	0..1	String	If the hotel is not specified, it returns Rooms and Rates of all user’s hotels.

HotelRatePlanInventoryRetrieve Response

After each request, Travelgate will process the data and provide you with a response. Upon receiving a HotelRatePlanInventoryRetrieve request, Travelgate will send you a corresponding HotelRatePlanInventoryRetrieve response.

The response options include either success or an error. In the event of success, Travelgate will provide you a response in which retrieves a list of Hotels > Rate Plans > Rooms, along with their configurations.

Success

<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-22T10:59:26.629Z</u:Created>
            <u:Expires>2023-11-22T11:04:26.629Z</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">
      <HotelRatePlanInventoryRetrieveResponse xmlns="http://schemas.xmltravelgate.com/hubpush/provider/2012/10">
         <HotelRatePlanInventoryRetrieveResult>
            <Success xmlns="http://www.opentravel.org/OTA/2003/05"/>
            <RatePlans HotelCode="2" HotelName="Hotel Test Pruebas Travelgate 2" HotelStatusType="Active" xmlns="http://www.opentravel.org/OTA/2003/05">
               <RatePlan Duration="0" CurrencyCode="EUR" PromotionCode="25" RatePlanType="11" RatePlanCode="BAR" RateReturn="false" FreeChild="false" FreeBaby="true" RatePlanStatusType="Active" IsModifiable="true" YieldableIndicator="false">
                  <BookingRules>
                     <BookingRule Start="2023-11-30" End="2023-11-30">
                        <CancelPenalties>
                           <CancelPenalty>
                              <Deadline OffsetTimeUnit="Day" OffsetUnitMultiplier="20" OffsetDropTime="BeforeArrival"/>
                              <AmountPercent NmbrOfNights="3"/>
                           </CancelPenalty>
                           <CancelPenalty>
                              <Deadline OffsetTimeUnit="Day" OffsetUnitMultiplier="10" OffsetDropTime="BeforeArrival"/>
                              <AmountPercent Amount="10"/>
                           </CancelPenalty>
                           <CancelPenalty>
                              <Deadline OffsetTimeUnit="Day" OffsetUnitMultiplier="0" OffsetDropTime="BeforeArrival"/>
                              <AmountPercent/>
                           </CancelPenalty>
                        </CancelPenalties>
                     </BookingRule>
                     <BookingRule Start="2023-12-01" End="2023-12-01">
                        <CancelPenalties>
                           <CancelPenalty>
                              <Deadline OffsetTimeUnit="Day" OffsetUnitMultiplier="20" OffsetDropTime="BeforeArrival"/>
                              <AmountPercent NmbrOfNights="3"/>
                           </CancelPenalty>
                           <CancelPenalty>
                              <Deadline OffsetTimeUnit="Day" OffsetUnitMultiplier="10" OffsetDropTime="BeforeArrival"/>
                              <AmountPercent Amount="10"/>
                           </CancelPenalty>
                           <CancelPenalty>
                              <Deadline OffsetTimeUnit="Day" OffsetUnitMultiplier="0" OffsetDropTime="BeforeArrival"/>
                              <AmountPercent/>
                           </CancelPenalty>
                        </CancelPenalties>
                     </BookingRule>
					 <BookingRule>
                        <Viewerships>
                           <Viewership>
                              <LocationCodes LocationCodesInclusive="true">
                                 <LocationCode CountryCode="ES"/>
                              </LocationCodes>
                           </Viewership>
                           <Viewership>
                              <LocationCodes LocationCodesInclusive="false"/>
                           </Viewership>
                        </Viewerships>
                     </BookingRule>
                  </BookingRules>
				  <Rates>
                     <Rate>
                        <AdditionalGuestAmounts>
                           <AdditionalGuestAmount AgeQualifyingCode="8" MaxAge="12"/>
                           <AdditionalGuestAmount AgeQualifyingCode="7" MaxAge="2"/>
                        </AdditionalGuestAmounts>
                        <PaymentPolicies>
                           <GuaranteePayment PaymentCode="MerchantPayment"/>
                           <GuaranteePayment PaymentCode="DirectPayment">
                              <AcceptedPayments>
                                 <AcceptedPayment>
                                    <PaymentCard CardCode="VI">
                                       <IsVCC>false</IsVCC>
                                    </PaymentCard>
                                 </AcceptedPayment>
                              </AcceptedPayments>
                           </GuaranteePayment>
                        </PaymentPolicies>
                        <MealsIncluded MealPlanCodes="14"/>
                     </Rate>
                  </Rates>
				  <Offers>
                     <Offer OfferCode="offer" OfferStatusType="Active">
                        <OfferRules>
                           <OfferRule>
                              <DateRestriction Start="01/03/2018 0:00:00" End="06/03/2018 0:00:00"/>
                              <LengthsOfStay ArrivalDateBased="false">
                                 <LengthOfStay Time="2" MinMaxMessageType="MinLOS"/>
                                 <LengthOfStay Time="6" MinMaxMessageType="MaxLOS"/>
                              </LengthsOfStay>
                              <DOW_Restrictions>
                                 <AvailableDaysOfWeek Mon="true" Tue="true" Weds="true" Thur="true" Fri="true" Sat="true" Sun="true"/>
                              </DOW_Restrictions>
                              <Inventories>
                                 <Inventory InvCode="STD3"/>
                              </Inventories>
                           </OfferRule>
                        </OfferRules>
                        <Discount NightsDiscounted="1" DiscountPattern="Last"/>
                        <OfferDescription>
                           <Text>Offer Test</Text>
                        </OfferDescription>
                     </Offer>
				  </Offers>
				  <SellableProducts>
                     <SellableProduct InvCode="STD2" InvType="ROOM" InvStatusType="Active" InvTypeCode="MYROOM2">
                        <GuestRoom>
                           <Quantities StandardNumBeds="2"/>
                           <Occupancy MinOccupancy="2" MaxOccupancy="2" AgeQualifyingCode="10"/>
                           <Room RoomTypeCode="STD2" RoomID="47915"/>
                           <Description>
                              <Text>Standard</Text>
                           </Description>
                        </GuestRoom>
                     </SellableProduct>
                     <SellableProduct InvCode="STD3" InvType="ROOM" InvStatusType="Active" InvTypeCode="MYROOM3">
                        <GuestRoom>
                           <Quantities StandardNumBeds="3"/>
                           <Occupancy MinOccupancy="2" MaxOccupancy="2" AgeQualifyingCode="10"/>
                           <Occupancy MinOccupancy="1" MaxOccupancy="1" AgeQualifyingCode="8"/>
                           <Room RoomTypeCode="STD3" RoomID="47918"/>
                           <Description>
                              <Text>Triple</Text>
                           </Description>
                        </GuestRoom>
                     </SellableProduct>
                  </SellableProducts>
                  <Commission Percent="15"/>
                  <Description>
                     <Text>Test rate</Text>
                  </Description>
                  <Taxes>
                     <Tax Amount="20" CurrencyCode="EUR" ChargeUnit="PerPax" ChargeFrequency="PerNight">
                        <TaxDescription>
                           <Text>City</Text>
                        </TaxDescription>
                     </Tax>
                  </Taxes>
                  <Fees>
                     <AmendFees>
                        <AmendFee Amount="13" CurrencyCode="EUR" ChargeUnit="2"/>
                     </AmendFees>
                  </Fees>
                  <AdditionalDetails>
                     <AdditionalDetail Code="code" Type="39">
                        <DetailDescription>
                           <Text>Negotiated</Text>
                        </DetailDescription>
                     </AdditionalDetail>
                  </AdditionalDetails>
               </RatePlan>
            </RatePlans>
         </HotelRatePlanInventoryRetrieveResult>
      </HotelRatePlanInventoryRetrieveResponse>
   </s:Body>
</s:Envelope>

Success Response Data Breakdown

Element Rel Type Description

HotelRatePlanInventoryRetrieveResult 1

HotelRatePlanInventoryRetrieveResult/Success 0..1

HotelRatePlanInventoryRetrieveResult/RatePlans 0..1

@HotelCode 1 String Hotel code

@HotelName 1 String Hotel name

@HotelStatusType 1 String Active or Deactivated

RatePlans/RatePlan 0..n

@FreeChild 1 Boolean Indicates if childern are free with this rate plan.

@FreeBaby 1 Boolean Indicates if babies are free with this rate plan.

@RatePlanCode 1 String Rate code

@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'.

@RateReturn 0..1 Boolean If true, the base rate will be provided to the channel instead of the derived one.

@RatePlanNotifType 0..1 String New, Delta or Remove

@RatePlanStatusType 1 String Active or Deactivated

@CurrencyCode 0..1 String ISO Currency. This field is exclusively used for Basic Rates.

@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.

@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.

@RatePlanType

0..1

String

Rate Rule Codes

Code	Description
0	No selected
7	Large Family
8	Public Servant
10	Negotiated
11	Package
34	Canary Resident
35	Balearic Resident
36	Honeymoon

If the attribute is not present and it is a Base Rate, the value is 0; if it is a Derived Rate, the value is the same as the Base Rate.

@PromotionCode

0..1

String

Senior Rates Codes

Code	Description
0	No promotion
25	Senior 55
26	Senior 60
27	Senior 65

If the attribute is not present or its value is 0, there is no promotion.

@Duration 0..1 String Duration of the rate booking window. Only present if Start and End are not. When present value is always 0 and means the rate has no booking window (available all dates).

@IsModifiable 0..1 Boolean If present and equals true, the rate will allow modifications. To apply fees, check Amend Fees.

RatePlan/Commission 0..1

@Percent 1 Decimal Commission percentage applied.

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.

LocationCodes/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

Integer

Age Qualifying Codes

Code	Description
7	Baby
8	Child
10	Adult

@MaxAge 1 Integer Max age of the additional guest.

Rate/PaymentPolicies 1

PaymentPolicies/GuaranteePayment 1..n

@PaymentCode

Integer

Payment Type Codes

Code	Description
MerchantPayment	The customer pays the client and the client will pay the provider
DirectPayment	The customer will have to use a credit card as guarantee for the hotel and the payment will be done by the customer at check-in
BookingDatePayment	The client will use a credit card with the exact amount of the option so he can pay the provider/hotel. The provider will charge the payment on the reservation day
ArrivalDatePayment	The client will use a credit card with the exact amount of the option so he can pay the provider/hotel, the provider will charge the payment on the checking day

GuaranteePayment/AcceptedPayments 0..1 Only present if @PaymentCode is not 'MerchantPayment'.

AcceptedPayments/AcceptedPayment 1..n

AcceptedPayment/PaymentCard 1..n

@CardCode

String

Credit Card codes

Code	Name
VI	Visa
AX	American Express
BC	BC Card
CA	MasterCard
CB	Carte Blanche
CU	China Union Pay
DS	Discover
DC	Diners Club
T	Carta Si
R	Carte Bleue
N	Dankort
L	Delta
E	Electron
JC	Japan Credit Bureau
TO	Maestro
S	Switch
EC	Electronic Cash
EU	EuroCard
TP	Universal air travel card
OP	optima
ER	Air Canada/RnRoute
XS	access
O	others

Rate/MealsIncluded 0..1

@MealPlanCodes

Integer

Meal Plan codes

Code	Description
1	All inclusive
2	American
3	Bed & breakfast
4	Buffet breakfast
5	Caribbean breakfast
6	Continental breakfast
7	English breakfast
8	European plan
9	Family plan
10	Full board
11	Full breakfast
12	Half board/modified American plan
13	As brochured
14	Room only
15	Self catering
16	Bermuda
17	Dinner bed and breakfast plan
18	Family American
19	Breakfast
20	Modified
255	Full board And Drinks
256	Half board And Drinks
257	All inclusive Premium
258	Gala Dinner
259	All Inclusive Light
260	Bed and breakfast + Half board
261	All Inclusive Limited
262	Bed and Brunch
263	Full board wine and water
264	Half board wine and water

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

@InvTypeCode 0..1 String External information about the room (own code, own description, etc.).

@InvType 1 String ROOM

@InvStatusType 1 String Active or Deactivated

@InvNotifType 0..1 String New, Delta or Remove

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

Integer

Age Qualifying Codes

Code	Description
7	Baby
8	Child
10	Adult

GuestRoom/Room 1

@RoomTypeCode 0..1 String Room code

@RoomID 1 Integer Room ID

GuestRoom/Description 0..1

Description/Text 1 String Room description

RatePlan/Taxes 0..1

Taxes/Tax 1..n

@Amount/Percent 1 Decimal Tax will be applied relative to an amount or a percentage.

@ChargeFrequency 0..1 Boolean Tax is applied or not based on the number of nights booked.

@ChargeUnit 0..1 Boolean Tax is applied or not based on the amount of paxes 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/RatePlanInclusionsType 0..1 Only used for Derivated Rates.

RatePlanInclusionsType/RatePlanInclusionDescription 1 Only used for Derivated Rates.

RatePlanInclusionDescription/Name 1 Only used for Derivated Rates.

RatePlan/Description 0..1

Description/Text 1 String Rate description

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/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.

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.

Inventories/Inventory 1..n

@InvCode 1 String Room code to which the offer will apply.

OfferRules/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.

OfferRule/OfferDescription 0..1

OfferDescription/Text 1 String Offer description

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.

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:11:00.838Z</u:Created>
            <u:Expires>2023-11-22T11:16:00.838Z</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">
      <HotelRatePlanInventoryRetrieveResponse xmlns="http://schemas.xmltravelgate.com/hubpush/provider/2012/10">
         <HotelRatePlanInventoryRetrieveResult>
            <Errors xmlns="http://www.opentravel.org/OTA/2003/05">
                <Error ShortText="Invalid hotel id" Code="10"/>
             </Errors>
         </HotelRatePlanInventoryRetrieveResult>
      </HotelRatePlanInventoryRetrieveResponse>
   </s:Body>
</s:Envelope>

Error Response Data Breakdown

Element

Rel

Type

Description

HotelRatePlanInventoryRetrieveResult

HotelRatePlanInventoryRetrieveResult/Errors

0..1

Errors/Error

@ShortText

String

Error Codes and Description

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

@Code

String

Error Codes and Description

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

Frequently Asked Questions

I have received the same room twice, why?

When you receive, for example, one hotel, one rate plan, and 2 rooms, where one of the rooms appears twice, it is because each one represents different occupancies. For instance, a standard room has 2 possible occupancies: 2 adults + 1 child or 2 adults.

How can I know if a rate has a meal plan adhered to it?

If your rate plan contains information about the adherence of meal plans, it will be displayed in the MealsIncluded tag.

What does New, Delta and Remove mean?

Rates can be created, deleted or modified. "New" means a newly added rate, "Delta" is for a changed rate, and "Removed" is used when a rate is deleted.

HotelRatePlanInventoryRetrieve Request​

Request Data Breakdown​

HotelRatePlanInventoryRetrieve Response​

Success​

Success Response Data Breakdown​

Error​

Error Response Data Breakdown​

Frequently Asked Questions​

HotelRatePlanInventoryRetrieve Request

Request Data Breakdown

HotelRatePlanInventoryRetrieve Response

Success

Success Response Data Breakdown

Error

Error Response Data Breakdown

Frequently Asked Questions