SMX Reservations API Change Log

Please check this page regularly for functionality and feature updates to SMX For Apps - Reservation API.

Removed / Modified / Added to the specification.

Upcoming Change Dec 2024

Addition of: ResStatus=”Redacted”

Impact

Reservations with a @ResStatus of “Redacted” will have all ‘PII’ data removed.

Important: The SMX partner application should be able to accept all ResStatus values and respond with Success (200 OK status). It will now need to handle the additional ‘Redacted’ value.

XML Sample of new ResStatus

<HotelReservations>
	<HotelReservation ResStatus="Redacted" CreateDateTime="2017-09-19T18:02:44+00:00" CreatorID="LINDA-RESAGENT" LastModifyDateTime="2017-09-19T18:13:51+00:00" LastModifierID="651651651651">
		<POS>…</POS>
		<UniqueID ID="BDC-3685569477"/>
		<RoomStays>…</RoomStays>
		<ResGlobalInfo>…</ResGlobalInfo>
	</HotelReservation>
</HotelReservations>

Updated 08-February-2024

Addition of: second AddressLine

Impact

Reservations may include a second AddressLine under ResGuest / Profile and ResGlobalInfo / Profile rather than having the two address lines merged in one AddressLine. LittleHotelier supports two-line addresses and have character limits for each. If there is data in the second line, it will be sent in the XML in a secondary AddressLine as below:

XML Sample of two AddressLine

<HotelReservations>
	<HotelReservation ResStatus="Redacted" CreateDateTime="2017-09-19T18:02:44+00:00" CreatorID="LINDA-RESAGENT" LastModifyDateTime="2017-09-19T18:13:51+00:00" LastModifierID="651651651651">
		<POS>…</POS>
		<UniqueID ID="BDC-3685569477"/>
		<RoomStays>…</RoomStays>
		<ResGlobalInfo>…</ResGlobalInfo>
	</HotelReservation>
</HotelReservations>

Updated 09-January-2024

Addition of: ResGlobalInfo and ResGuests / Profiles / UniqueID / ID

Impact

Little Hotelier reservations will contain a Guest ID under Profiles / UniqueID / ID. This is a randomly generated ID and will not be visible in Little Hotelier.

XML Sample of GuestID

<ResGuests>
    <ResGuest ResGuestRPH="2">
        <Profiles>
            <ProfileInfo>
                <UniqueID ID="1139" Type="1"/>
                <Profile ProfileType="1">
                
<ResGlobalInfo>
    <Profiles>
        <ProfileInfo>
            <UniqueID ID="1140" Type="1"/>
            <Profile ProfileType="1">
                <Customer VIP_Indicator="false">
                    <PersonName>
                        <GivenName>*****</GivenName>
                        <Surname>*****</Surname>
                    </PersonName>
                    <Address Type="1">
                        <AddressLine>*****</AddressLine>
                        <CityName>*****</CityName>
                        <StateProv>*****</StateProv>
                    </Address>
                </Customer>
            </Profile>
        </ProfileInfo>
    </Profiles>
</ResGlobalInfo>

Updated 09-January-2024

Addition of: ResGuest / PrimaryIndicator

Impact

Little Hotelier reservations will now identify the primary guest as PrimaryIndicator=”true” to know which guest is checking in. If multiple ResGuest / Profile are sent, only one will be identified as primary.

XML Sample of PrimaryIndicator

<ResGuests>
        <ResGuest ResGuestRPH="1">
        <ResGuest ResGuestRPH="1" PrimaryIndicator="true">
          <Profiles>
            <ProfileInfo>
              <Profile ProfileType="1">
            </ProfileInfo>
          </Profiles>
        </ResGuest>

Updated 09-February-2022

Addition of: ResGlobalInfo / Total / Taxes

OTA_HotelResNotifRQ

Element
Attribute
Number
Description

ResGlobalInfo / Total

1

NOTE: If HotelReservations / HotelReservation / @ResStatus = 'Cancelled' the this element becomes optional.

@AmountBeforeTax

0..1

The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).

@AmountAfterTax

0..1

The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).

@CurrencyCode

0..1

An ISO 4217 (3) alpha character code that specifies a monetary unit.

Total / Taxes

0..99

A collection of taxes relating to the total reservation cost.

@CurrencyCode

0..1

An ISO 4217 (3) alpha character code that specifies a monetary unit.

@Amount

0..1

A monetary amount of tax.

Total / Taxes / Tax

0..99

This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways.

@Code

0..1

@Amount

0..1

A monetary amount of tax.

@CurrencyCode

0..1

An ISO 4217 (3) alpha character code that specifies a monetary unit.

@Percent

0..1

Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value).

Tax / TaxDescription

0..5

Text description of the taxes.

Tax / TaxDescription / Text

0..n

Textual description of Discount Reason.

Updated 07-February-2022

Removal of: ResGlobalInfo / DepositPayments / GuaranteePayment / AcceptedPayments / AcceptedPayment / DirectBill @amount @numberOfNights

OTA_HotelResNotifRQ

Element
Attribute
Number
Description

ResGlobalInfo / DepositPayments / GuaranteePayment / AcceptedPayments / AcceptedPayment / DirectBill

0..1

Details of a direct billing arrangement.

@DirectBill_ID

0..1

Identifier for the organization to be billed directly for travel services.

@Amount

0..1

A monetary amount taken for the deposit.

@NmbrOfNights

0..1

The number of nights of the hotel stay that are used to calculate the fee amount.

Updated 04-February-2022

Removal of: HotelReservation / Services / Service / ServiceDetails / GuestCounts / TimeSpan

Addition of: HotelReservation / Services / Service / ServiceDetails / TimeSpan

OTA_HotelResNotifRQ

Element
Attribute
Number
Description

Services / Service / ServiceDetails

0..1

Details on the Service including Guest Counts, Time Span of this Service, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Service and finally financial information related to the Service, including Guarantee, Deposit and Payment and Cancellation Penalties.

ServiceDetails / GuestCounts

0..1

A collection of Guest Counts associated to the whole Reservation or a particular Room Stay or Service.

ServiceDetails / GuestCounts / TimeSpan

@Start

0..1

The starting value of the time span.

@End

0..1

The ending value of the time span.

ServiceDetails / GuestCounts / GuestCount

0..99

A recurring element that identifies the number of guests and ages of the guests.

@AgeQualifyingCode

0..1

@Age

0..1

@Count

0..1

@AgeBucket

0..1

ServiceDetails / TimeSpan

0..1

The Time Span which covers the Service.

@Start

0..1

The starting value of the time span.

@End

0..1

The ending value of the time span.

PreviousChangelogNextSMX ARI API Change Log

Last updated