Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 17 Current »

Reservation Initiate Response returns final price and availability of the requested offer.

OTA_HotelResRS:

*mandatory

Element

Attribute

Type

Description

Min…Max occurs

TransactionIdentifier*

Unique transaction ID generated by GP Travel HUB. This attribute must be further passed on reservation confirmation or ignore step to identify the booking request.

1...1

Success*

For more information see Common Data Description section in Glossary.

Warnings/Warning

HotelReservations*

Unites all the separate room reservations in one basket.

1...1

ResStatus*

string ("Reserved", "Requested", "Request denied")

Mandatory only for multibooking reservation. Reservation status that can be one of:

"Reserved" - accommodation was successfully reserved. Anyway ,reservation confirmation request is still required.

"Request denied" - supplier denied this request and accommodation can not be booked.

"Requested" - GP Travel HUB has done best effort to ensure that accommodation can be booked, however, this status doesn't guarantee, that accommodation will be booked. This status usually denotes, that supplier doesn't support two-pass booking.

Important note: in Multibooking the status of the whole reservation (basket) is defined according to the status of sub-reservations and is calculated by the following priority:

  1. If any of HotelReservation has ResStatus Request denied=> ResStatus of the whole booking is Request denied.

  2. If any of HotelReservation has ResStatus Requested=> ResStatus of the whole booking is Requested.

  3. If any of HotelReservation has ResStatus Reserved=> ResStatus of the whole booking is Reserved.

1...1

HotelReservations/ HotelReservation*

In successful response, element represents booking information.

Important note: each separate room reservation has a separate reservation status (ResStatus), and these reservation statuses could differ for each reservation block. 

1...*

HotelReservations/Total

Total booking price for all rooms for all travelers and whole stay duration. If a Service was added in OTA_HotelResRQ, then the Total price includes the Service price. Mandatory only for multibooking reservation.

0...1

AmountAfterTax*

For more information see Common Data Description section in Glossary.

1...1

CurrencyCode*

1...1

CommissionAmount

Contains supplier comission if supplier returns it.

0...1

CommissionPercent

Contains the commission percent.

0...1

HotelReservations/ HotelReservationIDs/ HotelReservationID

The same client/agent reservation ID that has been sent in Reservation Initiate Request. For multi-room booking is mandatory, it defines a unique basket identifier within all separate room reservations.

0...1

ResID_Source*

string ("basket")

Has value "basket" for the whole list of room reservations.

1...1

ResID_Value*

string

A unique identifier of a separate multi-room reservation (basket).

1...1

OTA_HotelResRS/HotelReservations/HotelReservation*:

Element

Attribute

Type

Description

Min…Max occurs

ResStatus*

string ("Reserved", "Requested", "Request denied")

Shows the status of a particular reservation.

1...1

RoomStays/RoomStay*

Room description that correspond to requested rooms.

1...*

ResGuests/ResGuest*

For more information see Reservation Initiate Request section.

1...*

ResGlobalInfo*

For more information see Reservation Initiate Request section.

1...1

OTA_HotelResRS/HotelReservations/HotelReservation/RoomStays/RoomStay*:

Element

Attribute

Type

Description

Min…Max occurs

RoomTypes/RoomType*

For more information see Hotel Availability Response section.

1...1

RatePlans/RatePlan*

For more information see Hotel Availability Response section.

1...1

RoomRates/RoomRate*

Contains room offer description including availability, room type, meal type, discount and price.

1...*

TimeSpan*

For more information see Common Data Description section in Glossary.

Guarantee

For more information see Hotel Availability Response section.

0...5

CancelPenalties/CancelPenalty

For more information see Hotel Availability Response section.

0...*

Total*

For more information see Hotel Availability Response section.

1...1

TotalRetail

For more information see Hotel Availability Response section.

0...1

BasicPropertyInfo*

For more information see Hotel Availability Response section.

1...1

OTA_HotelResRS/HotelReservations/HotelReservation/RoomStays/RoomStay/RoomRates/RoomRate*:

Elements are the same as in Hotel Availability Response, but some are added:

Element

Attribute

Type

Description

Min…Max occurs

InvBlockCode*

A room identifier. Must start from 1 and must be unique within booking. Together with ResGuestRPH this element allows to allocate passengers in rooms. It must be "1" in current implementation. For multi-room reservation InvBlockCode increments within next room reservation.

1...1

Services/Service

Additional services that can be booked with room.  

Note: Reservation Initiate Response will return ONLY services that were requested at Reservation Initiate Request, not all the services available.

Note: In Reservation Initiate and Confirmation Responses price for the service is always included in Total Price.

Note: In Reservation Initiate and Confirmation Responses Inclusive attribute will always have value Inclulsive=“true“.

Attributes remain the same as in Hotel Availability Response, might be one additional:

0...*

ReservationStatusType*

Has the same type as ResStatus.

Specifies booking status of requested services.

Note: If ResStatus is “Reserved“ it does not guarantee that ReservationStatusType will be “Reseved” too. Service booking status and the status of the reservation may be different.

1…1

 Reservation Initiate Response Sample XML - 2 adults 1 child
<OTA_HotelResRS Version="2" TransactionIdentifier="12232" EchoToken="EchoToken" xmlns:ota="http://www.opentravel.org/OTA/2003/05">
   <Success/>
   <HotelReservations>
      <HotelReservation ResStatus="Reserved">
         <RoomStays>
            <RoomStay>
               <RoomTypes>
                  <RoomType RoomTypeCode="2,3" SupplierRoomTypeCode="2" SupplierRoomCategoryCode="3">
                     <RoomDescription Name="Double">
                        <Text>Double sea view</Text>
                     </RoomDescription>
                  </RoomType>
               </RoomTypes>
               <RatePlans>
                  <RatePlan RatePlanCode="AB,1" SupplierRatePlanCode="AB" SupplierContractCode="1">
                     <MealsIncluded Breakfast="true" Dinner="false" Lunch="false" MealPlanCodes="3"/>
                     <AdditionalDetails>
                        <AdditionalDetail Code="AB" Type="15">
                           <DetailDescription Language="en">
                              <Text>Continental Breakfast</Text>
                           </DetailDescription>
                        </AdditionalDetail>
                     </AdditionalDetails>
                  </RatePlan>
               </RatePlans>
               <RoomRates>
                  <RoomRate InvBlockCode="1" AvailabilityStatus="AvailableForSale" BookingCode="1001" NumberOfUnits="1" RatePlanCode="AB,1" RoomTypeCode="2,3" RatePlanCategory="PackageOnly" Blind="false">
                     <Rates>
                        <Rate AgeQualifyingCode="10" RateSource="Hotel">
                           <Total AmountAfterTax="300.00" CurrencyCode="EUR"/>
                           <TotalRetail AmountAfterTax="320.00" CurrencyCode="EUR" IsMin="true" IsMax="true"/>
                        </Rate>
                        <Rate AgeQualifyingCode="10" RateSource="Hotel">
                           <Total AmountAfterTax="300.00" CurrencyCode="EUR"/>
                           <TotalRetail AmountAfterTax="320.00" CurrencyCode="EUR" IsMin="true" IsMax="true"/>
                        </Rate>
                        <Rate AgeQualifyingCode="8" RateSource="Hotel">
                           <Total AmountAfterTax="60.00" CurrencyCode="EUR"/>
                           <TotalRetail AmountAfterTax="60.00" CurrencyCode="EUR" IsMin="true" IsMax="true"/>
                        </Rate>
                     </Rates>
                     <RoomRateDescription Name="GRAll">
                        <Text>This hotel only late check-in.</Text>
                     </RoomRateDescription>
                     <Discount AmountAfterTax="90.00" CurrencyCode="EUR">
                        <DiscountReason>
                           <Text>Special offer</Text>
                        </DiscountReason>
                     </Discount>
                     <Services>
                        <Service ServiceRPH="1000136" IsPerRoom="true" Inclusive="true" SpecialServiceType="Meal">
                           <Price>
                              <Base CurrencyCode="EUR" AmountAfterTax="70.00"/>
                           </Price>
                           <ServiceDetails ShortName="Continental Breakfast">
                              <ServiceDescription>
                                 <Text>Continental Breakfast</Text>
                              </ServiceDescription>
                           </ServiceDetails>
                        </Service>
                     </Services>
                     <Total AmountAfterTax="660.00" CurrencyCode="EUR"/>
                     <TotalRetail AmountAfterTax="700.00" CurrencyCode="EUR" IsMin="true" IsMax="true"/>
                  </RoomRate>
               </RoomRates>
               <TimeSpan Start="2020-10-20" End="2020-10-25"/>
               <CancelPenalties>
                  <CancelPenalty End="2009-10-20T00:00:00+02:00" Start="2009-10-17T00:00:00+02:00">
                     <AmountPercent Amount="199.00" CurrencyCode="EUR"/>
                  </CancelPenalty>
               </CancelPenalties>
               <Total AmountAfterTax="660.00" CurrencyCode="EUR"/>
               <TotalRetail AmountAfterTax="700.00" CurrencyCode="EUR" IsMin="true" IsMax="true"/>
               <BasicPropertyInfo HotelCityCode="LON" HotelCode="157292" HotelCodeContext="supplierCode" HotelName="Pullman Skipper" ChainCode="PLMN" ChainName="Pullman" BrandCode="ACR" BrandName="ACCOR">
                  <Award Provider="Hotel" Rating="4"/>
                  <RelativePosition Name="CityCenter" Nearest="true"/>
               </BasicPropertyInfo>
            </RoomStay>
         </RoomStays>
         <ResGuests>
            <ResGuest AgeQualifyingCode="10" ResGuestRPH="1">
               <Profiles>
                  <ProfileInfo>
                     <UniqueID ID="1" Type="1"/>
                     <Profile>
                        <Customer>
                           <PersonName>
                              <NamePrefix>Mr</NamePrefix>
                              <GivenName>Oleg</GivenName>
                              <Surname>Ivanov</Surname>
                           </PersonName>
                        </Customer>
                     </Profile>
                  </ProfileInfo>
               </Profiles>
            </ResGuest>
            <ResGuest AgeQualifyingCode="10" ResGuestRPH="1">
               <Profiles>
                  <ProfileInfo>
                     <UniqueID ID="2" Type="1"/>
                     <Profile>
                        <Customer>
                           <PersonName>
                              <NamePrefix>Mrs</NamePrefix>
                              <GivenName>Olga</GivenName>
                              <Surname>Ivanova</Surname>
                           </PersonName>
                        </Customer>
                     </Profile>
                  </ProfileInfo>
               </Profiles>
            </ResGuest>
            <ResGuest AgeQualifyingCode="8" ResGuestRPH="1">
               <Profiles>
                  <ProfileInfo>
                     <UniqueID ID="3" Type="1"/>
                     <Profile>
                        <Customer BirthDate="2014-07-18">
                           <PersonName>
                              <NamePrefix>Mr</NamePrefix>
                              <GivenName>Alexey</GivenName>
                              <Surname>Ivanov</Surname>
                           </PersonName>
                        </Customer>
                     </Profile>
                  </ProfileInfo>
               </Profiles>
            </ResGuest>
         </ResGuests>
         <ResGlobalInfo>
            <Comments>
               <Comment>
                  <Text>non-smoking room requested;king bed</Text>
               </Comment>
            </Comments>
            <HotelReservationIDs>
               <HotelReservationID ResID_Source="agent" ResID_Value="69552"/>
               <HotelReservationID ResID_Source="client" ResID_Value="264888"/>
            </HotelReservationIDs>
         </ResGlobalInfo>
      </HotelReservation>
   </HotelReservations>
</OTA_HotelResRS>
 Multibooking Reservation Initiate Response Sample XML
<OTA_HotelResRS EchoToken="EchoToken" TransactionIdentifier="156864" Version="2.0" xmlns="http://www.opentravel.org/OTA/2003/05">
   <Success/>
   <HotelReservations ResStatus="Requested">
      <HotelReservation ResStatus="Requested">
         <RoomStays>
            <RoomStay>
               <RoomTypes>
                  <RoomType RoomTypeCode="12530768-1" SupplierRoomCategoryCode="19-1" SupplierRoomTypeCode="5140022">
                     <RoomDescription Name="Suite| 2 Bedroom Suite + Breakfast Flex| One Bed Requested">
                        <Text>Suite| 2 Bedroom Suite + Breakfast Flex| One Bed Requested</Text>
                     </RoomDescription>
                  </RoomType>
               </RoomTypes>
               <RatePlans>
                  <RatePlan RatePlanCode="4-0">
                     <RatePlanDescription>
                        <Text>Breakfast Buffet</Text>
                     </RatePlanDescription>
                     <MealsIncluded Breakfast="true" Dinner="false" Lunch="false" MealPlanCodes="4"/>
                  </RatePlan>
               </RatePlans>
               <RoomRates>
                  <RoomRate AvailabilityStatus="AvailableForSale" BookingCode="10326490" InvBlockCode="1" NumberOfUnits="1" RatePlanCode="4-0" RoomTypeCode="12530768-1">
                     <Rates>
                        <Rate AgeQualifyingCode="10" RateSource="Calculated">
                           <Total AmountAfterTax="1638.00" CurrencyCode="GBP"/>
                        </Rate>
                        <Rate AgeQualifyingCode="10" RateSource="Calculated">
                           <Total AmountAfterTax="1638.00" CurrencyCode="GBP"/>
                        </Rate>
                        <Rate AgeQualifyingCode="8" RateSource="Calculated">
                           <Total AmountAfterTax="0.00" CurrencyCode="GBP"/>
                        </Rate>
                     </Rates>
                     <Total AmountAfterTax="3276.00" AmountBeforeTax="2730.00" CurrencyCode="GBP">
                        <Taxes>
                           <Tax Amount="546.00" Code="17" CurrencyCode="GBP"/>
                        </Taxes>
                     </Total>
                  </RoomRate>
               </RoomRates>
               <TimeSpan End="2018-10-25" Start="2018-10-20"/>
               <CancelPenalties>
                  <CancelPenalty End="2018-10-20T15:00:00+01:00" Start="2018-10-18T15:00:00+01:00">
                     <AmountPercent Amount="655.20" CurrencyCode="GBP" NmbrOfNights="1"/>
                  </CancelPenalty>
                  <CancelPenalty End="2018-10-25T00:00:00+01:00" PolicyCode="NoShow" Start="2018-10-20T15:00:00+01:00">
                     <AmountPercent Amount="655.20" CurrencyCode="GBP" NmbrOfNights="1"/>
                  </CancelPenalty>
               </CancelPenalties>
               <Total AmountAfterTax="3276.00" AmountBeforeTax="2730.00" CurrencyCode="GBP">
                  <Taxes>
                     <Tax Amount="546.00" Code="17" CurrencyCode="GBP"/>
                  </Taxes>
               </Total>
               <BasicPropertyInfo HotelCityCode="5981" HotelCode="1232470" HotelCodeContext="supplierCode" HotelDistrictCode="16194" HotelDistrictName="Westminster" HotelName="Taj 51 Buckingham Gate - Demo">
                  <CategoryCodes>
                     <HotelCategory Code="5" CodeDetail="5" GroupCode="Category"/>
                     <HotelCategory Code="20" CodeDetail="Hotel" GroupCode="Type"/>
                  </CategoryCodes>
                  <Award Provider="Hotel" Rating="5"/>
               </BasicPropertyInfo>
            </RoomStay>
         </RoomStays>
         <ResGuests>
            <ResGuest AgeQualifyingCode="10" ResGuestRPH="1">
               <Profiles>
                  <ProfileInfo>
                     <UniqueID ID="1" Type="1"/>
                     <Profile>
                        <Customer>
                           <PersonName>
                              <NamePrefix>Mr</NamePrefix>
                              <GivenName>Alexey</GivenName>
                              <Surname>Feofanov</Surname>
                           </PersonName>
                           <CitizenCountryName Code="RU"/>
                        </Customer>
                     </Profile>
                  </ProfileInfo>
               </Profiles>
            </ResGuest>
            <ResGuest AgeQualifyingCode="10" ResGuestRPH="1">
               <Profiles>
                  <ProfileInfo>
                     <UniqueID ID="2" Type="1"/>
                     <Profile>
                        <Customer>
                           <PersonName>
                              <NamePrefix>Mr</NamePrefix>
                              <GivenName>Ivan</GivenName>
                              <Surname>Feofanov</Surname>
                           </PersonName>
                           <CitizenCountryName Code="RU"/>
                        </Customer>
                     </Profile>
                  </ProfileInfo>
               </Profiles>
            </ResGuest>
            <ResGuest AgeQualifyingCode="8" ResGuestRPH="1">
               <Profiles>
                  <ProfileInfo>
                     <UniqueID ID="3" Type="1"/>
                     <Profile>
                        <Customer BirthDate="2016-05-14">
                           <PersonName>
                              <NamePrefix>Mr</NamePrefix>
                              <GivenName>Ivan</GivenName>
                              <Surname>Feofanov</Surname>
                           </PersonName>
                           <CitizenCountryName Code="RU"/>
                        </Customer>
                     </Profile>
                  </ProfileInfo>
               </Profiles>
            </ResGuest>
         </ResGuests>
         <ResGlobalInfo>
            <HotelReservationIDs>
               <HotelReservationID ResID_Source="client" ResID_Value="tour001"/>
               <HotelReservationID ResID_Source="agent" ResID_Value="tour001"/>
            </HotelReservationIDs>
         </ResGlobalInfo>
      </HotelReservation>
      <HotelReservation ResStatus="Requested">
         <RoomStays>
            <RoomStay>
               <RoomTypes>
                  <RoomType RoomTypeCode="12530768-1" SupplierRoomCategoryCode="19-1" SupplierRoomTypeCode="5140022">
                     <RoomDescription Name="Suite| 2 Bedroom Suite + Breakfast Flex| One Bed Requested">
                        <Text>Suite| 2 Bedroom Suite + Breakfast Flex| One Bed Requested</Text>
                     </RoomDescription>
                  </RoomType>
               </RoomTypes>
               <RatePlans>
                  <RatePlan RatePlanCode="4-0">
                     <RatePlanDescription>
                        <Text>Breakfast Buffet</Text>
                     </RatePlanDescription>
                     <MealsIncluded Breakfast="true" Dinner="false" Lunch="false" MealPlanCodes="4"/>
                  </RatePlan>
               </RatePlans>
               <RoomRates>
                  <RoomRate AvailabilityStatus="AvailableForSale" BookingCode="103264f4" InvBlockCode="2" NumberOfUnits="1" RatePlanCode="4-0" RoomTypeCode="12530768-1">
                     <Rates>
                        <Rate AgeQualifyingCode="10" RateSource="Calculated">
                           <Total AmountAfterTax="1638.00" CurrencyCode="GBP"/>
                        </Rate>
                        <Rate AgeQualifyingCode="10" RateSource="Calculated">
                           <Total AmountAfterTax="1638.00" CurrencyCode="GBP"/>
                        </Rate>
                        <Rate AgeQualifyingCode="8" RateSource="Calculated">
                           <Total AmountAfterTax="0.00" CurrencyCode="GBP"/>
                        </Rate>
                        <Rate AgeQualifyingCode="8" RateSource="Calculated">
                           <Total AmountAfterTax="0.00" CurrencyCode="GBP"/>
                        </Rate>
                     </Rates>
                     <Total AmountAfterTax="3276.00" AmountBeforeTax="2730.00" CurrencyCode="GBP">
                        <Taxes>
                           <Tax Amount="546.00" Code="17" CurrencyCode="GBP"/>
                        </Taxes>
                     </Total>
                  </RoomRate>
               </RoomRates>
               <TimeSpan End="2018-10-25" Start="2018-10-20"/>
               <CancelPenalties>
                  <CancelPenalty End="2018-10-20T15:00:00+01:00" Start="2018-10-18T15:00:00+01:00">
                     <AmountPercent Amount="655.20" CurrencyCode="GBP" NmbrOfNights="1"/>
                  </CancelPenalty>
                  <CancelPenalty End="2018-10-25T00:00:00+01:00" PolicyCode="NoShow" Start="2018-10-20T15:00:00+01:00">
                     <AmountPercent Amount="655.20" CurrencyCode="GBP" NmbrOfNights="1"/>
                  </CancelPenalty>
               </CancelPenalties>
               <Total AmountAfterTax="3276.00" AmountBeforeTax="2730.00" CurrencyCode="GBP">
                  <Taxes>
                     <Tax Amount="546.00" Code="17" CurrencyCode="GBP"/>
                  </Taxes>
               </Total>
               <BasicPropertyInfo HotelCityCode="5981" HotelCode="1232470" HotelCodeContext="supplierCode" HotelDistrictCode="16194" HotelDistrictName="Westminster" HotelName="Taj 51 Buckingham Gate - Demo">
                  <CategoryCodes>
                     <HotelCategory Code="5" CodeDetail="5" GroupCode="Category"/>
                     <HotelCategory Code="20" CodeDetail="Hotel" GroupCode="Type"/>
                  </CategoryCodes>
                  <Award Provider="Hotel" Rating="5"/>
               </BasicPropertyInfo>
            </RoomStay>
         </RoomStays>
         <ResGuests>
            <ResGuest AgeQualifyingCode="10" ResGuestRPH="2">
               <Profiles>
                  <ProfileInfo>
                     <UniqueID ID="1" Type="1"/>
                     <Profile>
                        <Customer>
                           <PersonName>
                              <NamePrefix>Mr</NamePrefix>
                              <GivenName>Oleg</GivenName>
                              <Surname>Petrov</Surname>
                           </PersonName>
                        </Customer>
                     </Profile>
                  </ProfileInfo>
               </Profiles>
            </ResGuest>
            <ResGuest AgeQualifyingCode="10" ResGuestRPH="2">
               <Profiles>
                  <ProfileInfo>
                     <UniqueID ID="2" Type="1"/>
                     <Profile>
                        <Customer>
                           <PersonName>
                              <NamePrefix>Mr</NamePrefix>
                              <GivenName>Ivan</GivenName>
                              <Surname>Feofanov</Surname>
                           </PersonName>
                           <CitizenCountryName Code="RU"/>
                        </Customer>
                     </Profile>
                  </ProfileInfo>
               </Profiles>
            </ResGuest>
            <ResGuest AgeQualifyingCode="8" ResGuestRPH="2">
               <Profiles>
                  <ProfileInfo>
                     <UniqueID ID="3" Type="1"/>
                     <Profile>
                        <Customer BirthDate="2015-05-14">
                           <PersonName>
                              <NamePrefix>Mrs</NamePrefix>
                              <GivenName>Olga</GivenName>
                              <Surname>Petrova</Surname>
                           </PersonName>
                        </Customer>
                     </Profile>
                  </ProfileInfo>
               </Profiles>
            </ResGuest>
            <ResGuest AgeQualifyingCode="8" ResGuestRPH="2">
               <Profiles>
                  <ProfileInfo>
                     <UniqueID ID="4" Type="1"/>
                     <Profile>
                        <Customer BirthDate="2012-05-14">
                           <PersonName>
                              <NamePrefix>Mrs</NamePrefix>
                              <GivenName>Olga</GivenName>
                              <Surname>Petrova</Surname>
                           </PersonName>
                        </Customer>
                     </Profile>
                  </ProfileInfo>
               </Profiles>
            </ResGuest>
         </ResGuests>
         <ResGlobalInfo>
            <HotelReservationIDs>
               <HotelReservationID ResID_Source="client" ResID_Value="tour002"/>
               <HotelReservationID ResID_Source="agent" ResID_Value="tour002"/>
            </HotelReservationIDs>
         </ResGlobalInfo>
      </HotelReservation>
      <Total AmountAfterTax="6552.00" CurrencyCode="GBP"/>
      <HotelReservationIDs>
         <HotelReservationID ResID_Source="basket" ResID_Value="tourb001"/>
      </HotelReservationIDs>
   </HotelReservations>
</OTA_HotelResRS>
  • No labels