Skip to main content

Hotel Availability

10.18
Hotel
Search
SOAP API
Hospitality

The Hotel Availability Request message provides the ability to search single or multiple properties for detailed availability and pricing information. The request is flexible allowing for multiple ways to search for hotels, filter the rates returned and specify the response type.

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_HotelAvail

The information sections available in a hotel availability message are as follows:

  • Basic Request Parameters
    • Language and Culture Code
    • Currency Code
    • Dates
    • Guest Counts
  • Search Types
    • Hotel Code
    • Destination Code
    • Position and Radius
  • Available Filters
    • Rate Plan Code
    • Rate Plan Filter Code
    • Promotion/Corporate Code
    • Min/Max Rate Range
    • Min/Max Rate Only
    • Lowest Rate Only
  • Response Types
    • Availability with Descriptive Content
    • Availability without Descriptive Content
    • Availability Calendar
    • Availability Calendar with Pricing
  • Dynamic Packaging Types
    • No Inventory
    • Total Inventory
    • Daily Inventory
    • Daily Timestamp Inventory
Sample Request
<OTA_HotelAvailRQ EchoToken="Test20190911" PrimaryLangID="en" MaxResponses="0" ExactMatchOnly="false" BestOnly="false" SummaryOnly="false" HotelStayOnly="false" xmlns="http://www.opentravel.org/OTA/2003/05">
  <POS>
    <Source>
      <RequestorId ID="1001" ID_Context="Synxis">
        <CompanyName Code="DCTEST"/>
      </RequestorId>
    </Source>
  </POS>
  <AvailRequestSegments>
    <AvailRequestSegment AvailReqType="Room">
      <StayDateRange Start="2019-12-01" End="2019-12-02"/>
      <RoomStayCandidates>
        <RoomStayCandidate Quantity="1">
          <GuestCounts>
            <GuestCount AgeQualifyingCode="10" Count="1"/>
          </GuestCounts>
        </RoomStayCandidate>
      </RoomStayCandidates>
      <HotelSearchCriteria>
        <Criterion>
          <HotelRef HotelCode="16608" />
        </Criterion>
      </HotelSearchCriteria>
    </AvailRequestSegment>
  </AvailRequestSegments>
</OTA_HotelAvailRQ>
Sample Response
<OTA_HotelAvailRS EchoToken="Test20190911" PrimaryLangID="en" TimeStamp="2019-09-11T19:39:25+00:00" xmlns="http://www.opentravel.org/OTA/2003/05">
  <Success/>
  <RoomStays>
    <RoomStay>
      <RoomTypes>
        <RoomType RoomTypeCode="SK" NumberOfUnits="100">
          <RoomDescription Name="Standard King">
            <Text>This is the long description of the standard king</Text>
            <Image>https://reservations.synxis.com/hotel/16608/images/room/roomimage 1.jpg</Image>
          </RoomDescription>
          <Occupancy MaxOccupancy="3"/>
          <AdditionalDetails>
            <AdditionalDetail Type="4" Code="ShortDescription">
              <DetailDescription>
                <Text>This is the short description of the standard king.</Text>
              </DetailDescription>
            </AdditionalDetail>
            <AdditionalDetail Type="4" Code="LongDescription">
              <DetailDescription>
                <Text>This is the long description of the standard king</Text>
              </DetailDescription>
            </AdditionalDetail>
          </AdditionalDetails>
          <TPA_Extensions ADACompliantIndicator="false"/>
        </RoomType>
        <RoomType RoomTypeCode="SQ" NumberOfUnits="20">
          <RoomDescription Name="Standard Queen">
            <Text>This is the long description of the standard queen.</Text>
            <Image>https://reservations.synxis.com/hotel/16608/images/room/roomimage 4.jpg</Image>
          </RoomDescription>
          <Occupancy MaxOccupancy="2"/>
          <AdditionalDetails>
            <AdditionalDetail Type="4" Code="ShortDescription">
              <DetailDescription>
                <Text>This is the short description of the standard queen.</Text>
              </DetailDescription>
            </AdditionalDetail>
            <AdditionalDetail Type="4" Code="LongDescription">
              <DetailDescription>
                <Text>This is the long description of the standard queen.</Text>
              </DetailDescription>
            </AdditionalDetail>
          </AdditionalDetails>
          <TPA_Extensions ADACompliantIndicator="false"/>
        </RoomType>
        <RoomType RoomTypeCode="SUPERIOR" NumberOfUnits="6">
          <RoomDescription Name="01-Superior Room Accessible">
            <Text>Individually designed Superior Double Room (approx. 27sqm or 291sqf) with one Queen bed. Interiors reflect a fresh, modern English style and are characterized by dramatic oversized bed heads sleek modern furniture and specially designed accessories and lighting. The room is equipped with writing desk, small sitting area, LCD television, DVD, high speed wireless internet access, modem and fax points, two line telephones with voice mail, personal electronic safe and a fully stocked mini bar.</Text>
            <Image>https://reservations.synxis.com/hotel/16608/images/room/roomimage 1.jpg</Image>
          </RoomDescription>
          <Occupancy MaxOccupancy="2"/>
          <AdditionalDetails>
            <AdditionalDetail Type="4" Code="ShortDescription">
              <DetailDescription>
                <Text>Superior Room Accessible</Text>
              </DetailDescription>
            </AdditionalDetail>
            <AdditionalDetail Type="4" Code="LongDescription">
              <DetailDescription>
                <Text>Individually designed Superior Double Room (approx. 27sqm or 291sqf) with one Queen bed. Interiors reflect a fresh, modern English style and are characterized by dramatic oversized bed heads sleek modern furniture and specially designed accessories and lighting. The room is equipped with writing desk, small sitting area, LCD television, DVD, high speed wireless internet access, modem and fax points, two line telephones with voice mail, personal electronic safe and a fully stocked mini bar.</Text>
              </DetailDescription>
            </AdditionalDetail>
          </AdditionalDetails>
          <TPA_Extensions ADACompliantIndicator="true"/>
        </RoomType>
      </RoomTypes>
      <RatePlans>
        <RatePlan RatePlanCode="RAC" RatePlanName="Rack Rate">
          <RatePlanDescription Name="Rack Rate">
            <Text>This is the long description of the rack rate</Text>
          </RatePlanDescription>
          <Guarantee GuaranteeCode="GTD">
            <GuaranteeDescription>
              <Text>Guarantee by Credit Card required.</Text>
            </GuaranteeDescription>
          </Guarantee>
          <CancelPenalties>
            <CancelPenalty PolicyCode="3D">
              <PenaltyDescription>
                <Text>Cxl 3 days prior to start of arrival date to avoid fees</Text>
              </PenaltyDescription>
              <AmountPercent NmbrOfNights="1" TaxInclusive="true"/>
              <Deadline OffsetTimeUnit="Day" OffsetUnitMultiplier="3" OffsetDropTime="BeforeArrival"/>
            </CancelPenalty>
          </CancelPenalties>
          <Commission>
            <Percent>10</Percent>
            <Comment Name="Description">
              <Text>System Generated Policy  10pct.</Text>
            </Comment>
          </Commission>
          <MealsIncluded Breakfast="false"/>
        </RatePlan>
        <RatePlan RatePlanCode="BAR" RatePlanName="Best Available Rate">
          <RatePlanDescription Name="Best Available Rate">
            <Text>Excludes VAT and breakfast.</Text>
          </RatePlanDescription>
          <Guarantee GuaranteeCode="GTD">
            <GuaranteeDescription>
              <Text>Guarantee by Credit Card required.</Text>
            </GuaranteeDescription>
          </Guarantee>
          <CancelPenalties>
            <CancelPenalty PolicyCode="3D">
              <PenaltyDescription>
                <Text>Cxl 3 days prior to start of arrival date to avoid fees</Text>
              </PenaltyDescription>
              <AmountPercent NmbrOfNights="1" TaxInclusive="true"/>
              <Deadline OffsetTimeUnit="Day" OffsetUnitMultiplier="3" OffsetDropTime="BeforeArrival"/>
            </CancelPenalty>
          </CancelPenalties>
          <Commission>
            <Percent>10</Percent>
            <Comment Name="Description">
              <Text>System Generated Policy  10pct.</Text>
            </Comment>
          </Commission>
          <MealsIncluded Breakfast="false"/>
        </RatePlan>
      </RatePlans>
      <RoomRates>
        <RoomRate RoomTypeCode="SK" RatePlanCode="RAC" NumberOfUnits="100">
          <Rates>
            <Rate>
              <CancelPolicies>
                <CancelPenalty PolicyCode="3D">
                  <PenaltyDescription>
                    <Text>Cxl 3 days prior to start of arrival date to avoid fees</Text>
                  </PenaltyDescription>
                  <AmountPercent Amount="195.80" CurrencyCode="USD" TaxInclusive="true"/>
                  <Deadline OffsetTimeUnit="Day" OffsetUnitMultiplier="3" OffsetDropTime="BeforeArrival"/>
                </CancelPenalty>
              </CancelPolicies>
              <PaymentPolicies>
                <GuaranteePayment GuaranteeCode="GTD">
                  <Description>
                    <Text>Guarantee by Credit Card required.</Text>
                  </Description>
                  <AmountPercent Amount="0.00" CurrencyCode="USD" TaxInclusive="false"/>
                </GuaranteePayment>
              </PaymentPolicies>
              <Base AmountBeforeTax="160.00" AmountAfterTax="195.80" CurrencyCode="USD"/>
              <Fees>
                <Fee Amount="25.00" CurrencyCode="USD"/>
              </Fees>
              <Total AmountBeforeTax="160.00" AmountAfterTax="195.80" CurrencyCode="USD">
                <Taxes Amount="35.80">
                  <Tax Amount="10.80" Code="15" EffectiveDate="2019-12-01" ExpireDate="2019-12-01" ChargeFrequency="1">
                    <TaxDescription Name="Name">
                      <Text>State</Text>
                    </TaxDescription>
                    <TaxDescription Name="Description">
                      <Text/>
                    </TaxDescription>
                  </Tax>
                  <Tax Amount="25.00" Code="12" EffectiveDate="2019-12-01" ExpireDate="2019-12-01" ChargeFrequency="1">
                    <TaxDescription Name="Name">
                      <Text>Test Fee</Text>
                    </TaxDescription>
                    <TaxDescription Name="Description">
                      <Text/>
                    </TaxDescription>
                  </Tax>
                </Taxes>
              </Total>
              <Taxes>
                <Tax Amount="10.80" CurrencyCode="USD"/>
              </Taxes>
              <Tpa_Extensions>
                <NightlyRate Date="12/1/2019" Price="160.00" Tax="10.80" Fee="25.00" PriceWithTaxAndFee="195.80"/>
              </Tpa_Extensions>
            </Rate>
          </Rates>
        </RoomRate>
        <RoomRate RoomTypeCode="SQ" RatePlanCode="RAC" NumberOfUnits="20">
          <Rates>
            <Rate>
              <CancelPolicies>
                <CancelPenalty PolicyCode="3D">
                  <PenaltyDescription>
                    <Text>Cxl 3 days prior to start of arrival date to avoid fees</Text>
                  </PenaltyDescription>
                  <AmountPercent Amount="142.42" CurrencyCode="USD" TaxInclusive="true"/>
                  <Deadline OffsetTimeUnit="Day" OffsetUnitMultiplier="3" OffsetDropTime="BeforeArrival"/>
                </CancelPenalty>
              </CancelPolicies>
              <PaymentPolicies>
                <GuaranteePayment GuaranteeCode="GTD">
                  <Description>
                    <Text>Guarantee by Credit Card required.</Text>
                  </Description>
                  <AmountPercent Amount="0.00" CurrencyCode="USD" TaxInclusive="false"/>
                </GuaranteePayment>
              </PaymentPolicies>
              <Base AmountBeforeTax="110.00" AmountAfterTax="142.42" CurrencyCode="USD"/>
              <Fees>
                <Fee Amount="25.00" CurrencyCode="USD"/>
              </Fees>
              <Total AmountBeforeTax="110.00" AmountAfterTax="142.42" CurrencyCode="USD">
                <Taxes Amount="32.42">
                  <Tax Amount="7.42" Code="15" EffectiveDate="2019-12-01" ExpireDate="2019-12-01" ChargeFrequency="1">
                    <TaxDescription Name="Name">
                      <Text>State</Text>
                    </TaxDescription>
                    <TaxDescription Name="Description">
                      <Text/>
                    </TaxDescription>
                  </Tax>
                  <Tax Amount="25.00" Code="12" EffectiveDate="2019-12-01" ExpireDate="2019-12-01" ChargeFrequency="1">
                    <TaxDescription Name="Name">
                      <Text>Test Fee</Text>
                    </TaxDescription>
                    <TaxDescription Name="Description">
                      <Text/>
                    </TaxDescription>
                  </Tax>
                </Taxes>
              </Total>
              <Taxes>
                <Tax Amount="7.42" CurrencyCode="USD"/>
              </Taxes>
              <Tpa_Extensions>
                <NightlyRate Date="12/1/2019" Price="110.00" Tax="7.42" Fee="25.00" PriceWithTaxAndFee="142.42"/>
              </Tpa_Extensions>
            </Rate>
          </Rates>
        </RoomRate>
        <RoomRate RoomTypeCode="SUPERIOR" RatePlanCode="BAR" NumberOfUnits="6">
          <Rates>
            <Rate>
              <CancelPolicies>
                <CancelPenalty PolicyCode="3D">
                  <PenaltyDescription>
                    <Text>Cxl 3 days prior to start of arrival date to avoid fees</Text>
                  </PenaltyDescription>
                  <AmountPercent Amount="339.91" CurrencyCode="USD" TaxInclusive="true"/>
                  <Deadline OffsetTimeUnit="Day" OffsetUnitMultiplier="3" OffsetDropTime="BeforeArrival"/>
                </CancelPenalty>
              </CancelPolicies>
              <PaymentPolicies>
                <GuaranteePayment GuaranteeCode="GTD">
                  <Description>
                    <Text>Guarantee by Credit Card required.</Text>
                  </Description>
                  <AmountPercent Amount="0.00" CurrencyCode="USD" TaxInclusive="false"/>
                </GuaranteePayment>
              </PaymentPolicies>
              <Base AmountBeforeTax="295.00" AmountAfterTax="339.91" CurrencyCode="USD"/>
              <Fees>
                <Fee Amount="25.00" CurrencyCode="USD"/>
              </Fees>
              <Total AmountBeforeTax="295.00" AmountAfterTax="339.91" CurrencyCode="USD">
                <Taxes Amount="44.91">
                  <Tax Amount="19.91" Code="15" EffectiveDate="2019-12-01" ExpireDate="2019-12-01" ChargeFrequency="1">
                    <TaxDescription Name="Name">
                      <Text>State</Text>
                    </TaxDescription>
                    <TaxDescription Name="Description">
                      <Text/>
                    </TaxDescription>
                  </Tax>
                  <Tax Amount="25.00" Code="12" EffectiveDate="2019-12-01" ExpireDate="2019-12-01" ChargeFrequency="1">
                    <TaxDescription Name="Name">
                      <Text>Test Fee</Text>
                    </TaxDescription>
                    <TaxDescription Name="Description">
                      <Text/>
                    </TaxDescription>
                  </Tax>
                </Taxes>
              </Total>
              <Taxes>
                <Tax Amount="19.91" CurrencyCode="USD"/>
              </Taxes>
              <Tpa_Extensions>
                <NightlyRate Date="12/1/2019" Price="295.00" Tax="19.91" Fee="25.00" PriceWithTaxAndFee="339.91"/>
              </Tpa_Extensions>
            </Rate>
          </Rates>
        </RoomRate>
      </RoomRates>
      <BasicPropertyInfo HotelCode="16608" HotelName="Synxis Interface Test Hotel II">
        <Address FormattedInd="false" DefaultInd="false">
          <AddressLine>39 Chapel St</AddressLine>
          <CityName>Newton</CityName>
          <PostalCode>02458</PostalCode>
          <StateProv StateCode="MA"/>
          <CountryName Code="US"/>
        </Address>
        <ContactNumbers>
          <ContactNumber PhoneTechType="1" PhoneNumber="617-244-0444" DefaultInd="true"/>
        </ContactNumbers>
      </BasicPropertyInfo>
    </RoomStay>
  </RoomStays>
  <Criteria>
    <Criterion>
      <HotelRef HotelCode="16608" HotelName="Synxis Interface Test Hotel II"/>
    </Criterion>
  </Criteria>
</OTA_HotelAvailRS>