SiteMinder APIs
Help CentrePartner ContactsTest Extranet LoginBecome a SiteMinder Partner
  • Hub
  • Quickstart
  • Integration Process
  • CHANNELS
    • Introduction
      • SiteConnect
        • Getting Started
        • Developer Guide
          • Integration Requirements
          • Message Structure
          • Error Handling
        • API Reference
          • Rooms and Rates
          • Availability and Restrictions
          • Rates
          • Reservations
            • Reservation XML Sample
        • Testing and Certification
        • Changelog
        • FAQ
      • Channels Plus
        • Getting Started
        • Developer Guide
          • Partner Portal
          • Deals
          • Invoicing: Gross vs. Net
        • API Reference
          • Properties
          • Property
          • Lock Reservation
          • Confirm Reservation
          • Modify Reservation
          • Cancel Reservation
        • Testing and Certification
        • Swagger
        • Changelog
        • FAQ
  • PMS / RMS
    • Introduction
      • pmsXchange
        • Getting Started
        • Developer Guide
          • Integration Requirements
          • Message Structure
          • Error Handling
        • API Reference
          • Rooms and Rates
          • Availability and Restrictions
          • Rates
          • Reservations
            • Reservations PULL
            • Reservations Import
            • Reservations Upload
              • Reservation Types
            • Payment Transaction Record
            • Credit Card Tokenization
            • Reservations XML Samples
              • Reservations PULL Samples
              • Reservations Upload Samples
        • Testing and Certification
        • Changelog
        • FAQ
  • APPS
    • Introduction
      • SiteMinder Exchange
        • Getting Started
        • Developer Guide
          • Integration Requirements
          • Message Structure
          • Error Handling
        • API Reference
          • Availability and Rates
            • Publishers
            • Hotels
            • RoomTypes
            • RatePlans
            • Availability
            • Rates
            • Models
            • Response Samples
              • Publishers Sample
              • Hotels Sample
              • RoomTypes Samples
              • RatePlans Samples
              • Availability Samples
              • Rates Sample
            • ARI 1-Way Guidelines
          • Reservations
            • Maximum Content Sample
            • Minimum Content Sample
        • Testing and Certification
        • Activation & Deactivation Process for Hotels
          • Activation Process for Hotels
          • Activation Form Parameterisation
          • Deactivation Process for Hotels
        • Changelog
          • Reservations API Changelog
          • ARI API Changelog
        • FAQ
  • Additional Resources
    • Reference Tables
      • Booking Agent Codes
      • Document Type Code (DOC)
      • Error Codes (ERR)
      • Error Warning Types (EWT)
      • Fee Tax Type (FTT)
      • Handling HTTP 500
      • Meal Plan Type (MPT)
      • OpenTravel Codes List
      • Payment Card Provider Codes
      • Service and Extra Charge
      • Strong Customer Authentication Codes
      • Test Credit Cards
    • Glossary
    • FAQ
Powered by GitBook
On this page
  • Maximum Content XML
  • Minimum Content XML

Was this helpful?

  1. PMS / RMS
  2. Introduction
  3. pmsXchange
  4. API Reference
  5. Reservations
  6. Reservations XML Samples

Reservations PULL Samples

Maximum Content XML

The maximum amount of nodes that can be expected in a SiteMinder reservation.

<OTA_ResRetrieveRS xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.0" TimeStamp="2005-08-01T09:32:47+08:00" EchoToken="echo-abc123">
    <Success/>
    <ReservationsList>
        <HotelReservation CreateDateTime="2007-12-09T08:51:45.000+0000" ResStatus="Book">
            <POS>
                <Source>
                    <RequestorID Type="22" ID="SITEMINDER"/>
                    <BookingChannel Primary="true" Type="7">
                        <CompanyName Code="EXP">Expedia</CompanyName>
                    </BookingChannel>
                </Source>
                <Source>
                    <BookingChannel Primary="false" Type="7">
                        <CompanyName Code="EXPA">Expedia Affilate Account</CompanyName>
                    </BookingChannel>
                </Source>
            </POS>
            <UniqueID Type="14" ID="EXP-001"/>
            <UniqueID Type="16" ID="1243132" ID_Context="MESSAGE_UNIQUE_ID"/>
            <RoomStays>
                <RoomStay MarketCode="Corporate" PromotionCode="STAYANDSAVE" SourceOfBusiness="Radio">
                    <RoomTypes>
                        <RoomType RoomType="Double Room" RoomTypeCode="DR" NonSmoking="true" Configuration="2 Beds and 1 cot">
                            <RoomDescription>
                                <Text>Double room</Text>
                            </RoomDescription>
                            <AdditionalDetails>
                                <AdditionalDetail Type="4" Code="PIA">
                                    <DetailDescription>
                                        <Text>Room paid in advance with credit card</Text>
                                    </DetailDescription>
                                </AdditionalDetail>
                                <AdditionalDetail Type="7">
                                    <DetailDescription>
                                        <Text>Cancellation deadline 10/10/2012</Text>
                                    </DetailDescription>
                                </AdditionalDetail>
                            <AdditionalDetail Type="5" Code="ECB">
                                <DetailDescription>
                                    <Text>Continental breakfast included</Text>
                                </DetailDescription>
                            </AdditionalDetail>
                          </AdditionalDetails>
                        </RoomType>
                    </RoomTypes>
                    <RatePlans>
                        <RatePlan RatePlanCode="RAC1" EffectiveDate="2013-03-12" ExpireDate="2013-03-14" RatePlanName="RACK Rate1">
                            <RatePlanDescription>
                                <Text>Long Stay Discount</Text>
                            </RatePlanDescription>
                            <AdditionalDetails>
                                <AdditionalDetail Type="15" Code="EB1">
                                    <DetailDescription>
                                        <Text>Stay n Save promotion grants 10% discount</Text>
                                    </DetailDescription>
                                </AdditionalDetail>
                                <AdditionalDetail Type="43">
                                    <DetailDescription>
                                        <Text>Continental breakfast included</Text>
                                    </DetailDescription>
                                </AdditionalDetail>
                                <AdditionalDetail Type="5" Code="ECB">
                                    <DetailDescription>
                                        <Text>Expedia Collect</Text>
                                    </DetailDescription>
                                </AdditionalDetail>
                            </AdditionalDetails>
                        </RatePlan>
                        <RatePlan RatePlanCode="RAC2" EffectiveDate="2013-03-14" ExpireDate="2013-03-15" RatePlanName="RACK Rate2">
                            <RatePlanDescription>
                                <Text>Discounted Daily Rate</Text>
                            </RatePlanDescription>
                            <AdditionalDetails>
                                <AdditionalDetail Type="15" Code="EB1">
                                    <DetailDescription>
                                        <Text>Single Night Discount Promo</Text>
                                    </DetailDescription>
                                </AdditionalDetail>
                                <AdditionalDetail Type="43">
                                    <DetailDescription>
                                        <Text>Continental breakfast included</Text>
                                    </DetailDescription>
                                </AdditionalDetail>
                                <AdditionalDetail Type="5" Code="ECB">
                                    <DetailDescription>
                                        <Text>Expedia Collect</Text>
                                    </DetailDescription>
                                </AdditionalDetail>
                            </AdditionalDetails>
                        </RatePlan>
                    </RatePlans>
                    <RoomRates>
                        <RoomRate RoomTypeCode="DR" RatePlanCode="RAC1" NumberOfUnits="1">
                            <Rates>
                                <Rate UnitMultiplier="2" RateTimeUnit="Day" EffectiveDate="2013-03-12" ExpireDate="2013-03-14">
                                    <Base AmountBeforeTax="200.00" AmountAfterTax="220.00" CurrencyCode="USD">
                                        <Taxes Amount="20.00">
                                            <Tax Code="19" Percent="10" Amount="20.00">
                                                <TaxDescription>
                                                    <Text>GST 10 percent</Text>
                                                </TaxDescription>
                                            </Tax>
                                        </Taxes>
                                    </Base>
                                    <Total AmountBeforeTax="202.50" AmountAfterTax="222.75" CurrencyCode="USD">
                                        <Taxes Amount="20.25">
                                            <Tax Code="19" Percent="10" Amount="20.25">
                                                <TaxDescription>
                                                    <Text>GST 10 percent</Text>
                                                </TaxDescription>
                                            </Tax>
                                        </Taxes>
                                    </Total>
                                </Rate>
                            </Rates>
                            <ServiceRPHs>
                                <ServiceRPH RPH="1"/>
                            </ServiceRPHs>
                        </RoomRate>
                        <RoomRate RoomTypeCode="DR" RatePlanCode="RAC2" NumberOfUnits="1">
                            <Rates>
                                <Rate UnitMultiplier="1" RateTimeUnit="Day" EffectiveDate="2013-03-14" ExpireDate="2013-03-15">
                                    <Base AmountBeforeTax="100.00" AmountAfterTax="110.00" CurrencyCode="USD">
                                        <Taxes Amount="10.00">
                                            <Tax Code="19" Percent="10" Amount="10.00">
                                                <TaxDescription>
                                                    <Text>GST 10 percent</Text>
                                                </TaxDescription>
                                            </Tax>
                                        </Taxes>
                                    </Base>
                                    <Total AmountBeforeTax="102.50" AmountAfterTax="112.75" CurrencyCode="USD">
                                        <Taxes Amount="10.25">
                                            <Tax Code="19" Percent="10" Amount="10.25">
                                                <TaxDescription>
                                                    <Text>GST 10 percent</Text>
                                                </TaxDescription>
                                            </Tax>
                                        </Taxes>
                                    </Total>
                                </Rate>
                            </Rates>
                            <ServiceRPHs>
                                <ServiceRPH RPH="2"/>
                            </ServiceRPHs>
                        </RoomRate>
                    </RoomRates>
                    <ServiceRPHs>
                        <ServiceRPH RPH="3"/>
                    </ServiceRPHs>
                    <GuestCounts>
                        <GuestCount AgeQualifyingCode="10" Count="1"/>
                        <GuestCount AgeQualifyingCode="8" Count="1"/>
                        <GuestCount AgeQualifyingCode="7" Count="1"/>
                    </GuestCounts>
                    <TimeSpan Start="2013-03-12" End="2013-03-15"/>
                    <Total AmountAfterTax="568.25" CurrencyCode="USD"/>
                    <BasicPropertyInfo HotelCode="10107"/>
                    <ResGuestRPHs>
                        <ResGuestRPH RPH="1"/>
                    </ResGuestRPHs>
                    <Comments>
                        <Comment>
                            <Text>non-smoking Room requested, king bed</Text>
                        </Comment>
                    </Comments>
                </RoomStay>
            </RoomStays>
            <Services>
                <Service ServiceInventoryCode="EXTRA_BED" Inclusive="true" ServiceRPH="1" Quantity="1" ID="12345" ID_Context="CHANNEL" Type="18">
                    <Price>
                        <Base AmountBeforeTax="2.50" AmountAfterTax="2.75" CurrencyCode="USD">
                            <Taxes Amount="0.25">
                                <Tax Code="19" Percent="10" Amount="0.25">
                                    <TaxDescription>
                                        <Text>GST 10 percent</Text>
                                    </TaxDescription>
                                </Tax>
                            </Taxes>
                        </Base>
                        <Total AmountBeforeTax="5.00" AmountAfterTax="5.50" CurrencyCode="USD">
                            <Taxes Amount="0.50">
                                <Tax Code="19" Percent="10" Amount="0.50">
                                    <TaxDescription>
                                        <Text>GST 10 percent</Text>
                                    </TaxDescription>
                                </Tax>
                            </Taxes>
                        </Total>
                        <RateDescription>
                            <Text>Extra person charge $2.50 (ex GST) per day for cot</Text>
                        </RateDescription>
                    </Price>
                    <ServiceDetails>
                        <TimeSpan End="2013-03-14" Start="2013-03-12"/>
                    </ServiceDetails>
                </Service>
                <Service ServiceInventoryCode="EXTRA_BED" Inclusive="true" ServiceRPH="2" Quantity="1" ID="12346" ID_Context="CHANNEL" Type="18">
                    <Price>
                        <Base AmountBeforeTax="2.50" AmountAfterTax="2.75" CurrencyCode="USD">
                            <Taxes Amount="0.25">
                                <Tax Code="19" Percent="10" Amount="0.25">
                                    <TaxDescription>
                                        <Text>GST 10 percent</Text>
                                    </TaxDescription>
                                </Tax>
                            </Taxes>
                        </Base>
                        <Total AmountBeforeTax="2.50" AmountAfterTax="2.75" CurrencyCode="USD">
                            <Taxes Amount="0.25">
                                <Tax Code="19" Percent="10" Amount="0.25">
                                    <TaxDescription>
                                        <Text>GST 10 percent</Text>
                                    </TaxDescription>
                                </Tax>
                            </Taxes>
                        </Total>
                        <RateDescription>
                            <Text>Extra person charge $2.50 (ex GST) per day for cot</Text>
                        </RateDescription>
                    </Price>
                    <ServiceDetails>
                        <TimeSpan End="2013-03-15" Start="2013-03-14"/>
                    </ServiceDetails>
                </Service>
                <Service ServiceInventoryCode="OTHER" Inclusive="true" ServiceRPH="3" Quantity="2" ID="12347" ID_Context="CHANNEL" Type="18">
                    <Price>
                        <Base AmountBeforeTax="4.55" AmountAfterTax="5.00" CurrencyCode="USD">
                            <Taxes Amount="0.45">
                                <Tax Code="19" Percent="10" Amount="0.45">
                                    <TaxDescription>
                                        <Text>GST 10 percent</Text>
                                    </TaxDescription>
                                </Tax>
                            </Taxes>
                        </Base>
                        <Total AmountBeforeTax="9.09" AmountAfterTax="10.00" CurrencyCode="USD">
                            <Taxes Amount="0.91">
                                <Tax Code="19" Percent="10" Amount="0.91">
                                    <TaxDescription>
                                        <Text>GST 10 percent</Text>
                                    </TaxDescription>
                                </Tax>
                            </Taxes>
                        </Total>
                        <RateDescription>
                            <Text>Extra bathrobe $5.00 (incl GST) per person</Text>
                        </RateDescription>
                    </Price>
                </Service>
                <Service ServiceInventoryCode="EXTRA" Inclusive="true" Quantity="1" ID="12348" ID_Context="CHANNEL" Type="18">
                    <Price>
                        <Base AmountBeforeTax="4.55" AmountAfterTax="5.00" CurrencyCode="USD">
                            <Taxes Amount="0.45">
                                <Tax Code="19" Percent="10" Amount="0.45">
                                    <TaxDescription>
                                        <Text>GST 10 percent</Text>
                                    </TaxDescription>
                                </Tax>
                            </Taxes>
                        </Base>
                        <Total AmountBeforeTax="13.65" AmountAfterTax="15.00" CurrencyCode="USD">
                            <Taxes Amount="1.35">
                                <Tax Code="19" Percent="10" Amount="1.35">
                                    <TaxDescription>
                                        <Text>GST 10 percent</Text>
                                    </TaxDescription>
                                </Tax>
                            </Taxes>
                        </Total>
                        <RateDescription>
                            <Text>Car Park - Undercover Parking (Clearance 2.2 meter or 7.2 feet) $5.00 (incl GST) per day</Text>
                        </RateDescription>
                    </Price>
                    <ServiceDetails>
                        <TimeSpan End="2013-03-15" Start="2013-03-12"/>
                    </ServiceDetails>
                </Service>
            </Services>
            <ResGuests>
                <ResGuest ResGuestRPH="1" ArrivalTime="10:30:00" Age="8" PrimaryIndicator="true">
                    <Profiles>
                        <ProfileInfo>
                            <UniqueID Type="16" ID="12345" ID_Context="CHANNEL"/>
                            <Profile ProfileType="1">
                                <Customer>
                                    <PersonName>
                                        <NamePrefix>Mr</NamePrefix>
                                        <GivenName>James</GivenName>
                                        <MiddleName>Herbert</MiddleName>
                                        <Surname>Bond</Surname>
                                    </PersonName>
                                    <Telephone PhoneNumber="555-1234"/>
                                    <Telephone PhoneNumber="555-4321" PhoneUseType="4"/>
                                    <Telephone PhoneNumber="0411444000" PhoneTechType="5"/>
                                    <Telephone PhoneNumber="213451515" PhoneTechType="3"/>
                                    <Email>james.bond@mi5.co.uk</Email>
                                    <Address>
                                        <AddressLine>Claretta House</AddressLine>
                                        <AddressLine>Tower Bridge Close</AddressLine>
                                        <CityName>London</CityName>
                                        <PostalCode>EC1 2PG</PostalCode>
                                        <StateProv>Middlesex</StateProv>
                                        <CountryName>United Kingdom</CountryName>
                                        <CompanyName>MI6</CompanyName>
                                    </Address>
                                    <CustLoyalty MembershipID="1234567890" ProgramID="FrequentFlyer" ExpiryDate="2017-03-31"/>
                                </Customer>
                            </Profile>
                        </ProfileInfo>
                    </Profiles>
                    <Comments>
                        <Comment Name="ArrivalDetails">
                            <Text>Arriving by coach</Text>
                        </Comment>
                        <Comment Name="DepartureDetails">
                            <Text>Departure flight QF123</Text>
                        </Comment>
                    </Comments>
                </ResGuest>
            </ResGuests>
            <ResGlobalInfo>
                <Guarantee>
                    <GuaranteesAccepted>
                        <GuaranteeAccepted>
                            <PaymentCard CardCode="VI" CardType="1" CardNumber="4444444444444444" ExpireDate="1114">
                                <CardHolderName>John Smith</CardHolderName>
                            </PaymentCard>
                        </GuaranteeAccepted>
                    </GuaranteesAccepted>
                    <Comments>
                        <Comment Name="PaymentReferenceId">
                            <Text>123124151616</Text>
                        </Comment>
                    </Comments>
                    <GuaranteeDescription>
                        <Text>Payment accepted up front</Text>
                    </GuaranteeDescription>
                </Guarantee>
                <DepositPayments>
                    <GuaranteePayment>
                        <AmountPercent Amount="291.63" Percent="50" CurrencyCode="USD"/>
                        <Description>
                            <Text>50% Deposit</Text>
                        </Description>
                    </GuaranteePayment>
                </DepositPayments>
                <Fees>
                    <Fee TaxInclusive="true" Type="Inclusive" Code="27" Amount="5.00">
                        <Taxes Amount="0.45"/>
                        <Description Name="Commission">
                            <Text>Commission - $5 flat fee</Text>
                        </Description>
                    </Fee>
                </Fees>
                <Total AmountAfterTax="583.25" CurrencyCode="USD">
                    <Taxes Amount="53.02">
                        <Tax Code="19" Percent="10" Amount="53.52">
                            <TaxDescription>
                                <Text>GST 10 percent</Text>
                            </TaxDescription>
                        </Tax>
                    </Taxes>
                </Total>
                <HotelReservationIDs>
                    <HotelReservationID ResID_Type="14" ResID_Value="RES_3243525"/>
                </HotelReservationIDs>
                <Profiles>
                    <ProfileInfo>
                        <UniqueID Type="16" ID="12345" ID_Context="CHANNEL"/>
                        <Profile ProfileType="1">
                            <Customer>
                                <PersonName>
                                    <NamePrefix>Mr</NamePrefix>
                                    <GivenName>James</GivenName>
                                    <MiddleName>Herbert</MiddleName>
                                    <Surname>Bond</Surname>
                                </PersonName>
                                <Telephone PhoneNumber="555-1234"/>
                                <Telephone PhoneNumber="555-4321" PhoneUseType="4"/>
                                <Telephone PhoneNumber="0411444000" PhoneTechType="5"/>
                                <Telephone PhoneNumber="213451515" PhoneTechType="3"/>
                                <Email>james.bond@mi5.co.uk</Email>
                                <Address>
                                    <AddressLine>Claretta House</AddressLine>
                                    <AddressLine>Tower Bridge Close</AddressLine>
                                    <CityName>London</CityName>
                                    <PostalCode>EC1 2PG</PostalCode>
                                    <StateProv>Middlesex</StateProv>
                                    <CountryName>United Kingdom</CountryName>
                                    <CompanyName>MI6</CompanyName>
                                </Address>
                                <CustLoyalty MembershipID="1234567890" ProgramID="FrequentFlyer" ExpiryDate="2017-03-31"/>
                            </Customer>
                        </Profile>
                    </ProfileInfo>
                    <ProfileInfo>
                        <UniqueID Type="16" ID="STA" ID_Context="CHANNEL"/>
                        <UniqueID Type="16" ID="12312414" ID_Context="IATA"/>
                        <Profile ProfileType="4">
                            <Customer>
                                <PersonName>
                                    <NamePrefix>Mis</NamePrefix>
                                    <Surname>Moneypenny</Surname>
                                </PersonName>
                                <Telephone PhoneNumber="555-1234"/>
                                <Address>
                                    <CompanyName>STA Travel</CompanyName>
                                </Address>
                            </Customer>
                        </Profile>
                    </ProfileInfo>
                </Profiles>
                <Comments>
                    <Comment>
                        <Text>will be arriving after 6 pm</Text>
                    </Comment>
                </Comments>
            </ResGlobalInfo>
        </HotelReservation>
    </ReservationsList>
</OTA_ResRetrieveRS>

Minimum Content XML

The minimum amount of nodes that can be expected in a SiteMinder reservation.

<OTA_ResRetrieveRS
	xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.0" TimeStamp="2005-08-01T09:32:47+08:00" EchoToken="echo-abc123">
	<Success/>
	<ReservationsList>
		<HotelReservation CreateDateTime="2007-12-09T08:51:45.000+0000" ResStatus="Book">
			<POS>
				<Source>
					<RequestorID Type="22" ID="SITEMINDER"/>
					<BookingChannel Primary="true" Type="7">
						<CompanyName Code="WTF">Wotif</CompanyName>
					</BookingChannel>
				</Source>
			</POS>
			<UniqueID Type="14" ID="WTF-001"/>
			<UniqueID Type="16" ID="1243132" ID_Context="MESSAGE_UNIQUE_ID"/>
			<RoomStays>
				<RoomStay>
					<RoomTypes>
						<RoomType RoomTypeCode="DR"/>
					</RoomTypes>
					<RatePlans>
						<RatePlan RatePlanCode="RAC" EffectiveDate="2013-03-12" ExpireDate="2013-03-15"/>
					</RatePlans>
					<RoomRates>
						<RoomRate RoomTypeCode="DR" RatePlanCode="RAC" NumberOfUnits="1">
							<Rates>
								<Rate UnitMultiplier="3" RateTimeUnit="Day" EffectiveDate="2013-03-12" ExpireDate="2013-03-15"/>
							</Rates>
						</RoomRate>
					</RoomRates>
					<GuestCounts>
						<GuestCount AgeQualifyingCode="10" Count="1"/>
					</GuestCounts>
					<TimeSpan Start="2013-03-12" End="2013-03-15"/>
					<BasicPropertyInfo HotelCode="10107"/>
				</RoomStay>
			</RoomStays>
			<ResGlobalInfo>
				<HotelReservationIDs>
					<HotelReservationID ResID_Type="14" ResID_Value="001"/>
				</HotelReservationIDs>
			</ResGlobalInfo>
		</HotelReservation>
	</ReservationsList>
</OTA_ResRetrieveRS>

Last updated 2 months ago

Was this helpful?