Skip to main content

Modify Reservation

10.18
Hotel
Reservation
SOAP API
Hospitality

The Modify Reservation (OTA_HotelResModifyRQ) is used to enable modifications of previously booked 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.18
Authentication
Security Credentials
Service Action Code
OTA_HotelResModifyRQ
  • OTA_HotelResModifyRQ — Sends a request message for a reservation modification.
  • OTA_HotelResModifyRS — Returns confirmation that the modification has been successfully booked, and includes a confirmation number to identify the reservation, as well as the full details of the modification. 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 HotelResModify node per requested modification always returns regardless of success. If the modification was not successfully processed, the node is empty. The error messages returned correspond to the failed modification – one error per failed modification in the response.

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

  • Provide the Synxis CR CustomerNumber in the ProfileInfo/UniqueID node.
    • If customer is found, the customer's information updates.
    • If customer is not found, the iteration in the reservation updates. Please note that if multiple customers are on the reservation, it is possible that a different customer can be modified.
  • Provide the ID (email address) and PinNumber in the UserID node.
    • If customer is found, the customer's information updates.
    • If customer is not found, the iteration in the reservation updates. Please note that if multiple customers are on the reservation, it is possible that a different customer can be modified.
  • Resend all customer data not including the Synxis CR CustomerNumber or User ID/Password. This creates a new profile in the system and ensures that all customer information is correct. If a profile already exists for this customer, this results in a duplicate profile.

When granted access, partners have the ability to override the rate amounts. Either the total amount of the reservation or daily rate amounts can be sent. Modifications are not performed at the itinerary level. The partner must make modifications to the individual reservations that comprise the itinerary.

Sample Request
<OTA_HotelResModifyRQ EchoToken="Test" PrimaryLangID="en" 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>
  <HotelResModifies>
    <HotelResModify RoomStayReservation="true">
      <UniqueID Type="14" ID="10107SY000917" ID_Context="CrsConfirmNumber"/>
      <RoomStays>
        <RoomStay>
          <RoomTypes>
            <RoomType RoomTypeCode="JRQ" NumberOfUnits="1"/>
          </RoomTypes>
          <RatePlans>
            <RatePlan RatePlanCode="Hotwire2" RatePlanID="HTW2"/>
          </RatePlans>
          <GuestCounts>
            <GuestCount AgeQualifyingCode="10" Count="2"/>
          </GuestCounts>
          <TimeSpan Start="2015-02-11" End="2015-02-12" Duration="P1N"/>
          <BasicPropertyInfo HotelCode="10107" ChainCode="5400"/>
          <SpecialRequests>
            <SpecialRequest RequestCode="OV" Description="Ocean View"/>
          </SpecialRequests>
        </RoomStay>
      </RoomStays>
      <ResGuests>
        <ResGuest>
          <Profiles>
            <ProfileInfo>
              <UniqueID Type="1" ID="10107C000001" ID_Context="CrsCustomerNumber"/>
              <Profile ProfileType="21">
                <UserID ID="customer@email.com" PinNumber="password"/>
                <Customer>
                  <PersonName>
                    <NamePrefix>Mr.</NamePrefix>
                    <GivenName>Customer</GivenName>
                    </MiddleName>
                    <Surname>Name</Surname>
                    <NameSuffix>Jr.</NameSuffix>
                  </PersonName>
                  <Telephone PhoneTechType="1" PhoneNumber="(617) 244-0444"/>
                  <Email>test@synxis.com</Email>
                  <Address Type="1" Remark="Home address" FormattedInd="false" DefaultInd="true">
                    <AddressLine>39 Chapel St.</AddressLine>
                    <AddressLine>Basement</AddressLine>
                    <AddressLine>Desk 10</AddressLine>
                    <CityName>Newton</CityName>
                    <PostalCode>02458</PostalCode>
                    <StateProv StateCode="MA"/>
                    <CountryName Code="US"/>
                  </Address>
                  <CustLoyalty ProgramID="Program1" MembershipID="44444" LoyalLevel="3" SignupDate="2006-09-15" ExpireDate="2016-09-12" EffectiveDate="2015-01-01" PinNumber="password"/>
                  <CustLoyalty ProgramID="Program2" MembershipID="55555" LoyalLevel="4" SignupDate="2011-09-15" ExpireDate="2016-09-12" EffectiveDate="2015-01-01" PinNumber="password2"/>
                  <ContactPerson>
                    <PersonName>
                      <GivenName>Contact Name</GivenName>
                      <Surname>Contact Last Name</Surname>
                    </PersonName>
                  </ContactPerson>
                </Customer>
              </Profile>
            </ProfileInfo>
          </Profiles>
        </ResGuest>
      </ResGuests>
      <ResGlobalInfo>
        <Comments>
          <Comment>
            <Text>Please ensure that ice is provided in the room.</Text>
          </Comment>
        </Comments>
        <Guarantee>
          <GuaranteesAccepted>
            <GuaranteeAccepted>
              <PaymentCard CardCode="VI" CardNumber="4111111111111111" ExpireDate="0907" SeriesCode="123">
                <CardHolderName>Card Holdername</CardHolderName>
              </PaymentCard>
            </GuaranteeAccepted>
          </GuaranteesAccepted>
        </Guarantee>
        <Profiles>
          <ProfileInfo>
            <UniqueID Type="5" ID="1234567" ID_Context="IATA"/>
            <Profile/>
          </ProfileInfo>
        </Profiles>
        <HotelReservationIDs>
          <HotelReservationID ResID_Type="14" ResID_Source="10" ResID_Value="XYZ123"/>
        </HotelReservationIDs>
      </ResGlobalInfo>
      <WrittenConfInst>
        <SupplementalData Name="EmailTemplateCode"/>
      </WrittenConfInst>
      <Services>
        <Service ServiceInventoryCode="SP">
          <ServiceDetails>
            <TimeSpan Start="2015-02-11T07:30:00"/>
            <GuestCounts>
              <GuestCount AgeQualifyingCode="10" Count="2"/>
            </GuestCounts>
          </ServiceDetails>
        </Service>
      </Services>
      <Verification>
        <TPA_Extensions>
          <BasicPropertyInfo HotelCode="10107"/>
        </TPA_Extensions>
      </Verification>
    </HotelResModify>
  </HotelResModifies>
</OTA_HotelResModifyRQ>
Sample Response
<OTA_HotelResModifyRS EchoToken="Test" PrimaryLangID="en" TimeStamp="2015-02-03T10:08:04Z" ResResponseType="Modified " 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/>
  <HotelResModifies>
    <HotelResModify RoomStayReservation="true">
      <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="HOTWIRE2" 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="HOTWIRE2" 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"/>
          <SpecialRequests>
            <SpecialRequest RequestCode="OV" Description="Ocean View"/>
          </SpecialRequests>
          <Memberships>
            <Membership ProgramCode="Program1" AccountID="44444" BonusCode="3" PointsEarned="300"/>
          </Memberships>
        </RoomStay>
      </RoomStays>
      <ResGuests>
        <ResGuest>
          <Profiles>
            <ProfileInfo>
              <UniqueID Type="1" ID="10107C000001" ID_Context="CrsCustomerNumber"/>
              <Profile ProfileType="21">
                <UserID ID="customer@email.com" PinNumber="password"/>
                <Customer>
                  <PersonName>
                    <NamePrefix>Mr.</NamePrefix>
                    <GivenName>Test</GivenName>
                    <MiddleName>T</MiddleName>
                    <Surname>Customer</Surname>
                    <NameSuffix>Jr.</NameSuffix>
                  </PersonName>
                  <Telephone PhoneNumber="(617) 244-0444"/>
                  <Telephone PhoneNumber="(617) 244-0445"/>
                  <Email>test@synxis.com</Email>
                  <Address Type="1" Remark="Home address" FormattedInd="false" DefaultInd="true">
                    <AddressLine>39 Chapel St.</AddressLine>
                     <AddressLine>Basement</AddressLine>
                    <AddressLine>Desk 10</AddressLine>
                    <CityName>Newton</CityName>
                    <PostalCode>02458</PostalCode>
                    <StateProv StateCode="MA"/>
                    <CountryName Code="US"/>
                  </Address>
                  <CustLoyalty ProgramID="Program1" MembershipID="44444" LoyalLevel="3" SignupDate="2006-09-15" ExpireDate="2016-09-12" EffectiveDate="2015-01-01"/>
                  <CustLoyalty ProgramID="Program2" MembershipID="55555" LoyalLevel="4" SignupDate="2011-09-15" ExpireDate="2016-09-12" EffectiveDate="2015-01-01"/>
                </Customer>
                <CompanyInfo>
                  <CompanyName>Synxis</CompanyName>
                </CompanyInfo>
              </Profile>
            </ProfileInfo>
          </Profiles>
        </ResGuest>
      </ResGuests>
      <ResGlobalInfo>
        <Comments>
          <Comment>
            <Text>Please ensure that ice is provided in the room.</Text>
          </Comment>
        </Comments>
        <Guarantee>
          <GuaranteesAccepted>
            <GuaranteeAccepted>
              <PaymentCard CardType="1" CardCode="VI" CardNumber="XXXXXXXXXXXX1111" ExpireDate="09/07" 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-10T09:13:06Z"/>
          <HotelReservationID ResID_Type="14" ResID_Value=" XYZ123" ResID_Source="10" ResID_SourceContext="Synxis"/>
        </HotelReservationIDs>
      </ResGlobalInfo>
      <Services>
        <Service ServicePricingType="Per Person" Inclusive="false" ServiceInventoryCode="CW" Quantity="2">
          <ServiceDetails>
            <GuestCounts>
              <GuestCount AgeQualifyingCode="10" Count="2"/>
            </GuestCounts>
            <TimeSpan Start="2015-02-11" Increment="00:00:00"/>
            <Comments>
              <Comment Name="Category">
                <Text>Champagne Wednesdays Category</Text>
              </Comment>
              <Comment Name="Title">
                <Text>Champagne Wednesdays</Text>
              </Comment>
              <Comment Name="Image">
                <Image>https://reservations.synxis.com/hotel/10001/images/Package/FruitCheese.jpg</Image>
              </Comment>
              <Comment Name="Description">
                <Text>Get Champagne if your stay falls on a Wednesday</Text>
              </Comment>
            </Comments>
          </ServiceDetails>
          <Price>
            <Base AmountBeforeTax="20" AmountAfterTax="25"/>
            <AdditionalGuestAmounts>
              <AdditionalGuestAmount TaxInclusive="True" AgeQualifyingCode="10">
                <Amount AmountBeforeTax="20" AmountAfterTax="25"/>
              </AdditionalGuestAmount>
            </AdditionalGuestAmounts>
          </Price>
        </Service>
      </Services>
    </HotelResModify>
  </HotelResModifies>
</OTA_HotelResModifyRS>