Skip to main content

Read Reservation

10.26
Hotel
Reservation
SOAP API
Hospitality

Not Signed In.

Looks like you may not have access to all of the resources and documentation for this page.
Please log-in or contact your support desk team if you believe you should have access.

The Read Reservations method using the OTA_ReadRQ message enables reservation records to be retrieved from the system by passing identifying information. If an exact reservation match is not found or a list is requested, the OTA_HotelResRS message is returned with a list of reservations.

Note -- A Read Reservations request message (OTA_ReadRQ) returns an (OTA_HotelResRS) response message containing the reservation details.

Target Audience
Hospitality
API Version
10.26
Authentication
Security Credentials
Service Action Code
OTA_ReadRQ
Sample Request
<OTA_ReadRQ ReturnListIndicator="true" EchoToken="Test" PrimaryLangID="en" MaxResponses="0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.opentravel.org/OTA/2003/05">
  <POS>
    <Source>
      <RequestorId ID="10" ID_Context="Synxis" />
    </Source>
  </POS>
  <ReadRequests>
    <ReadRequest>
      <UniqueID Type="14" ID="10107SY000917" ID_Context="CrsConfirmNumber" />
      <Verification>
        <TPA_Extensions>
          <BasicPropertyInfo HotelCode="10107" ChainCode="1234" />
        </TPA_Extensions>
      </Verification>
    </ReadRequest>
  </ReadRequests>
</OTA_ReadRQ>
Sample Response
<OTA_HotelResRS TimeStamp="2015-02-03T09:13:06Z" EchoToken="12345" PrimaryLangID="en" ResResponseType="Committed" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.opentravel.org/OTA/2003/05">
  <Success />
  <HotelReservations>
    <HotelReservation>
      <UniqueID Type="14" ID="10107SY000917" ID_Context="CrsConfirmNumber" />
      <RoomStays>
        <RoomStay MarketCode="Business" SourceOfBusiness="1">
          <Total AmountBeforeTax="100.00" AmountAfterTax="115.00" CurrencyCode="USD" />
          <RoomTypes>
            <RoomType RoomTypeCode="JRQ" NumberOfUnits="1">
              <RoomDescription Name="Junior Suite" />
            </RoomType>
          </RoomTypes>
          <RatePlans>
            <RatePlan RatePlanCode="HTWR2" RatePlanName="Hotwire2">
              <Guarantee>
                <GuaranteeDescription>
                  <Text>Credit Card Guarantee Required</Text>
                </GuaranteeDescription>
              </Guarantee>
              <CancelPenalties>
                <CancelPenalty>
                  <PenaltyDescription>
                    <Text>Cancel by 6pm day of arrival or fee of 1 night incl tax</Text>
                  </PenaltyDescription>
                </CancelPenalty>
              </CancelPenalties>
            </RatePlan>
          </RatePlans>
          <RoomRates>
            <RoomRate EffectiveDate="2015-02-11" ExpireDate="2015-02-11" RoomTypeCode="JRQ" RatePlanCode="HTWR2" NumberOfUnits="1">
              <Rates>
                <Rate>
                  <Base AmountBeforeTax="100.00" AmountAfterTax="115.00" CurrencyCode="USD" />
                  <Fees>
                    <Fee Amount="0.00" CurrencyCode="USD" />
                  </Fees>
                  <Total AmountBeforeTax="100.00" AmountAfterTax="115.00" CurrencyCode="USD" />
                  <Taxes>
                    <Tax Amount="15.00" CurrencyCode="USD" />
                  </Taxes>
                  <Tpa_Extensions>
                    <NightlyRate Date="2015-02-11" Price="100.00" Tax="15.00" Fee="0.00" PriceWithTaxAndFee="115.00" />
                  </Tpa_Extensions>
                </Rate>
              </Rates>
            </RoomRate>
          </RoomRates>
          <GuestCounts>
            <GuestCount AgeQualifyingCode="10" Count="2" />
          </GuestCounts>
          <TimeSpan Start="2015-02-11" End="2015-02-12" Duration="P1N" />
          <BasicPropertyInfo HotelCode="10107" HotelName="Synxis Test Hotel" ChainCode="5187" ChainName="APM Hotels" />
        </RoomStay>
      </RoomStays>
      <ResGuests>
        <ResGuest>
          <Profiles>
            <ProfileInfo>
              <UniqueID Type="1" ID="10107C000001" ID_Context="CrsCustomerNumber" />
              <Profile ProfileType="21">
                <Customer>
                  <PersonName>
                    <Surname>Customer</Surname>
                  </PersonName>
                </Customer>
              </Profile>
            </ProfileInfo>
          </Profiles>
        </ResGuest>
      </ResGuests>
      <ResGlobalInfo>
        <Guarantee>
          <GuaranteesAccepted>
            <GuaranteeAccepted>
              <PaymentCard CardType="1" CardCode="VI" CardNumber="XXXXXXXXXXXX1111" ExpireDate="09/17" SeriesCode="123">
                <CardHolderName>Card Holdername</CardHolderName>
              </PaymentCard>
            </GuaranteeAccepted>
          </GuaranteesAccepted>
        </Guarantee>
        <Total AmountBeforeTax="100.00" AmountAfterTax="115.00" CurrencyCode="USD" />
        <HotelReservationIDs>
          <HotelReservationID ResID_Type="14" ResID_Value="10107SY000917" ResID_Source="CRS" ResID_SourceContext="Synxis" ResID_Date="2015-02-12T09:13:06Z" />
          <HotelReservationID ResID_Type="14" ResID_Value=" XYZ123" ResID_Source="10" ResID_SourceContext="Synxis" />
        </HotelReservationIDs>
      </ResGlobalInfo>
      <TPA_Extensions>
        <ResStatus>Committed</ResStatus>
      </TPA_Extensions>
    </HotelReservation>
  </HotelReservations>
</OTA_HotelResRS>