Skip to main content

Reservation Pull - Retrieve (OTA)

10.16
Hotel
Reservation
SOAP API
Hospitality

The OTA_HotelGetMsg is used to request reservations in the SynXis CR and the response is used to return the pending reservations.

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.

Target Audience
Hospitality
API Version
10.16
Authentication
Security Credentials
Service Action Code
OTA_HotelResNotifRQ

The response includes multiple message elements including:

  • One OTA_HotelResNotifRQ message - all new reservations that were retrieved. If no new reservations were retrieved, an empty OTA_HotelResNotifRQ element returns as a placeholder.
  • One OTA_HotelResModifyNotifRQ message - all modified reservations that were retrieved. If no new modified reservations were retrieved, an empty OTA_HotelModifyResNotifRQ element is still returned as a placeholder
  • One or more OTA_CancelRQ messages - A separate Message and MessageContent element is added for each cancellation that is retrieved. The OTA_CancelRQ element contains one cancellation only. If there are no cancelled reservations, one OTA_CancelRQ element still returns as a placeholder.

 

Reservation Pull Flow

 

 

Sample Request
<OTA_HotelGetMsgRQ TimeStamp="2019-06-17T12:40:04" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.opentravel.org/OTA/2003/05">
    <Messages>
        <Message HotelCode="95049" HotelName="PMS Test Hotel" ChainCode="6835" ChainName="Test Chain" ReasonForRequest="Reservation Retrieval" RequestCode="Optional" MessageType="All" StartSeqNmbr="1" EndSeqNmbr="10"/>
    </Messages>
</OTA_HotelGetMsgRQ>
Sample Response
<OTA_HotelGetMsgRS PrimaryLangID="en" TimeStamp="2019-06-17T12:40:04">
    <Success />
    <Messages>
        <Message>
            <MessageContent>
                <OTA_HotelResNotifRQ EchoToken="3d14c2ec-5c78-46fa-ae16-eef593d13fe3" TimeStamp="2019-06-17T12:40:04" ResStatus="Book">
                    <HotelReservations>
                        <HotelReservation CreateDateTime="2019-06-17T12:31:33" RoomStayReservation="true" CreatorID="Synxis">
                            <UniqueID Type="14" ID="95049IC000019" ID_Context="CrsConfirmNumber"/>
                            <RoomStays>
                                <RoomStay MarketCode="RAC" SourceOfBusiness="1">
                                    <Total AmountBeforeTax="399.98" AmountAfterTax="439.98" CurrencyCode="USD" DecimalPlaces="2"/>
                                    <RoomTypes>
                                        <RoomType IsRoom="true" RoomTypeCode="DL1Q" InvBlockCode="" NumberOfUnits="1">
                                            <RoomDescription Name="Deluxe Queen"/>
                                        </RoomType>
                                    </RoomTypes>
                                    <RatePlans>
                                        <RatePlan RatePlanCode="RACK" BookingCode="RACK" RatePlanType="Unknown" EffectiveDate="2019-07-08" ExpireDate="2019-07-10">
                                            <RatePlanDescription Name="Standard Rate"/>
                                            <RatePlanInclusions TaxInclusive="false"/>
                                        </RatePlan>
                                    </RatePlans>
                                    <RoomRates>
                                        <RoomRate EffectiveDate="2019-07-08" ExpireDate="2019-07-09" RoomTypeCode="DL1Q" RatePlanCode="RACK" NumberOfUnits="1">
                                            <Rates>
                                                <Rate RateTimeUnit="Day" UnitMultiplier="1" EffectiveDate="2019-07-08" ExpireDate="2019-07-09">
                                                    <Base AmountBeforeTax="199.99" AmountAfterTax="219.99" CurrencyCode="USD" DecimalPlaces="2"/>
                                                    <Total AmountBeforeTax="199.99" AmountAfterTax="219.99" CurrencyCode="USD" DecimalPlaces="2"/>
                                                </Rate>
                                            </Rates>
                                        </RoomRate>
                                    </RoomRates>
                                    <GuestCounts IsPerRoom="true">
                                        <GuestCount AgeQualifyingCode="10" Count="1"/>
                                    </GuestCounts>
                                    <TimeSpan Start="2019-07-08" End="2019-07-10" Duration="P2N"/>
                                    <BasicPropertyInfo HotelCode="95049" HotelName="PMS Test Hotel"/>
                                </RoomStay>
                            </RoomStays>
                            <ResGuests>
                                <ResGuest PrimaryIndicator="true">
                                    <Profiles>
                                        <ProfileInfo>
                                            <UniqueID Type="1" ID="c688ad66fdb943ad946410b5610bb932" ID_Context="ProfileID"/>
                                            <UniqueID Type="1" ID="6835C0089489" ID_Context="crs" Instance="Master">
                                                <CompanyName CodeContext="chain" Code="6835"/>
                                            </UniqueID>
                                            <Profile ProfileType="1">
                                                <Comments />
                                                <Customer BirthDate="0001-01-01">
                                                    <PersonName>
                                                        <NamePrefix>Mr.</NamePrefix>
                                                        <GivenName>John</GivenName>
                                                        <MiddleName>-</MiddleName>
                                                        <Surname>Bill</Surname>
                                                        <NameSuffix />
                                                    </PersonName>
                                                    <Telephone FormattedInd="true" PhoneTechType="1" PhoneNumber="123-123-1234" PhoneUseType="3"/>
                                                    <Email>development@email.com</Email>
                                                    <Address Type="1" Remark="Personal" CompanyName="Adapt" FormattedInd="false" DefaultInd="false">
                                                        <AddressLine>3505 Highgate Hills</AddressLine>
                                                        <CityName>Duluth</CityName>
                                                        <PostalCode>30096</PostalCode>
                                                        <StateProv>GA</StateProv>
                                                        <CountryName>US</CountryName>
                                                    </Address>
                                                    <CustLoyalty MembershipID="123345" ProgramID="DL" VendorCode="DL" SignupDate="0001-01-01" EffectiveDate="0001-01-01" ExpireDate="0001-01-01"/>
                                                </Customer>
                                            </Profile>
                                        </ProfileInfo>
                                    </Profiles>
                                </ResGuest>
                            </ResGuests>
                            <ResGlobalInfo>
                                <Comments>
                                    <Comment>
                                        <Text />
                                    </Comment>
                                </Comments>
                                <Guarantee>
                                    <GuaranteesAccepted>
                                        <GuaranteeAccepted PaymentTransactionTypeCode="charge">
                                            <PaymentCard CardType="1" CardCode="VI" CardNumber="4444333322221111" SeriesCode="123" ExpireDate="1215">
                                                <CardHolderName>John B</CardHolderName>
                                            </PaymentCard>
                                        </GuaranteeAccepted>
                                    </GuaranteesAccepted>
                                </Guarantee>
                                <Total AmountBeforeTax="399.98" CurrencyCode="USD" DecimalPlaces="2"/>
                                <HotelReservationIDs>
                                    <HotelReservationID ResID_Type="14" ResID_Value="3d14c2ec-5c78-46fa-ae16-eef593d13fe3" ResID_Source="Synxis" ResID_SourceContext="Database Guid"/>
                                    <HotelReservationID ResID_Type="14" ResID_Value="95049IC000019" ResID_Source="CRS" ResID_SourceContext="CrsConfirmNumber"/>
                                    <HotelReservationID ResID_Type="14" ResID_Value="95049IC000019" ResID_Source="Synxis" ResID_SourceContext="CrsConfirmNumber"/>
                                </HotelReservationIDs>
                            </ResGlobalInfo>
                            <TPA_Extensions>
                                <GuaranteeDetails>
                                    <PaymentCardDetails PmsCreditCardCode="VI"/>
                                </GuaranteeDetails>
                                <SourceOfBusiness PrimaryCode="WEB" PrimaryID="1" SecondaryID="5" SecondaryCode="XBE" SubSourceID="" SubSourceCode="" MarketSourceCode="">WEB</SourceOfBusiness>
                                <MarketSegment MarketSegmentCode="RAC">RAC</MarketSegment>
                            </TPA_Extensions>
                        </HotelReservation>
                    </HotelReservations>
                </OTA_HotelResNotifRQ>
            </MessageContent>
        </Message>
        <Message>
            <MessageContent>
                <OTA_HotelResModifyNotifRQ TimeStamp="2019-06-17T12:40:05" ="4" ResStatus="Book"/>
            </MessageContent>
        </Message>
        <Message>
            <MessageContent>
                <OTA_CancelRQ PrimaryLangID="en" TimeStamp="2019-06-17T12:40:05" ="4" CancelType="cancel"/>
            </MessageContent>
        </Message>
    </Messages>
</OTA_HotelGetMsgRS>