Skip to main content

Create Reservation

10.18
Hotel
Reservation
SOAP API
Hospitality

The CreateReservations method provides the ability to send reservation requests to SynXis CR.

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.18
Authentication
Security Credentials
Service Action Code
OTA_HotelResRQ

The response returns confirmation that the reservation has been successfully booked, and includes a confirmation number to identify the reservation, as well as the full details of the reservation.  Warnings from business processing rules are returned if there was a non fatal error.  Errors are returned if the request did not succeed.  To ensure ease in determining the cause of errors, one HotelReservation node per requested reservation always returns regardless of success.  If the reservation does not successfully process, the node is empty.  The error messages returned correspond to the failed reservations – one error per failed reservation in the response.

A success element is added if any of the requested reservations are successful.  If the success element is not present then all reservations failed.  The errors element should be used to determine which reservations failed to process.  Each error element specifies a record ID that is the zero based array ID of the reservations requested.  For example, if three reservations are requested and the first two fail the record IDs included in errors would be 0 and 1.

There are two possible paths to create a reservation: straight to confirm or book, then confirm (2 Phase commit).  The first option creates the reservation and confirms it in one transaction.  The second option is a two-stage process that allows the reservation to be rolled back or committed using a follow-up message.  When granted access, partners have the ability to override the rate amounts found in the system.  Either the total amount of the reservation or daily rate amounts can be sent. The partner can optionally specify that the reservation is part of an existing or new itinerary.

 

Sample Request
<OTA_HotelResRQ PrimaryLangID="en" EchoToken="12345" ResStatus="Commit" 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">
        <CompanyName Code="WSBE" />
      </RequestorId>
    </Source>
  </POS>
  <HotelReservations>
    <HotelReservation RoomStayReservation="true">
      <RoomStays>
        <RoomStay>
          <RoomTypes>
            <RoomType RoomTypeCode="JRQ" NumberOfUnits="1" />
          </RoomTypes>
          <RatePlans>
            <RatePlan RatePlanCode="HTWR2" />
          </RatePlans>
          <GuestCounts>
            <GuestCount AgeQualifyingCode="10" Count="2" />
          </GuestCounts>
          <TimeSpan Start="2015-02-11" End="2015-02-12" Duration="P1N" />
          <BasicPropertyInfo HotelCode="10107" ChainCode="5400" />
        </RoomStay>
      </RoomStays>
      <ResGuests>
        <ResGuest>
          <Profiles>
            <ProfileInfo>
              <Profile>
                <Customer>
                  <PersonName>
                    <Surname>Last Name</Surname>
                  </PersonName>
                </Customer>
              </Profile>
            </ProfileInfo>
          </Profiles>
        </ResGuest>
      </ResGuests>
      <ResGlobalInfo>
        <Guarantee>
          <GuaranteesAccepted>
            <GuaranteeAccepted>
              <PaymentCard CardCode="VI" CardNumber="4111111111111111" ExpireDate="0907" SeriesCode="123">
                <CardHolderName>Card Holdername</CardHolderName>
              </PaymentCard>
            </GuaranteeAccepted>
          </GuaranteesAccepted>
        </Guarantee>
        <HotelReservationIDs>
          <HotelReservationID ResID_Type="14" ResID_Source="10" ResID_Value="XYZ123" />
        </HotelReservationIDs>
      </ResGlobalInfo>
      <WrittenConfInst>
        <SupplementalData Name="EmailTemplateCode" />
      </WrittenConfInst>
    </HotelReservation>
  </HotelReservations>
</OTA_HotelResRQ>
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>