Reservations Upload

Message Exchange Workflow

• OTA_HotelResNotifRQ - a request made by the PMS to the SMX endpoint.

• OTA_HotelResNotifRS - the response sent by SMX.

Request

Commit

Booking XML

<OTA_HotelResNotifRQ
	xmlns="http://www.opentravel.org/OTA/2003/05" ResStatus="Commit" EchoToken="ed8835ff-6198-4f38-b589-3058397f677c" TimeStamp="2024-07-06T15:27:41+00:00" Version="1.0">
	<!-- ... other elements and attributes have been omitted for brevity ... -->
</OTA_HotelResNotifRQ>

Modify

Modification XML

<OTA_HotelResNotifRQ
	xmlns="http://www.opentravel.org/OTA/2003/05" ResStatus="Modify" EchoToken="ed8835ff-6198-4f38-b589-3058397f677c" TimeStamp="2024-07-06T15:27:41+00:00" Version="1.0">
	<!-- ... other elements and attributes have been omitted for brevity ... -->
</OTA_HotelResNotifRQ>

Cancel

Cancellation XML

<OTA_HotelResNotifRQ
	xmlns="http://www.opentravel.org/OTA/2003/05" ResStatus="Cancel" EchoToken="ed8835ff-6198-4f38-b589-3058397f677c" TimeStamp="2024-07-06T15:27:41+00:00" Version="1.0">
	<!-- ... other elements and attributes have been omitted for brevity ... -->
</OTA_HotelResNotifRQ>

Element / @Attribute	Type	M	Description
OTA_HotelResNotifRQ	Element	1	Root element for the request.
@xmlns	String	1	Defines the XML namespace for the request. Will be set to http://www.opentravel.org/OTA/2003/05
@Version	Decimal	1	Specifies the API version. Must be set to 1.0.
@EchoToken	String	1	Unique identifier for the request, used to match requests and responses.
@TimeStamp	DateTime	1	The time when the request was generated.

Source

Source

<POS>
	<Source>
		<RequestorID Type="22" ID="ABC"/>
		<BookingChannel Primary="true">
			<CompanyName Code="ABC">Channel Name</CompanyName>
		</BookingChannel>
	</Source>
	<!-- Additional Source element -->
</POS>

Second Source

<POS>
	<Source>
		<RequestorID Type="22" ID="ABC"/>
		<BookingChannel Primary="true">
			<CompanyName Code="ABC">Channel Name</CompanyName>
		</BookingChannel>
	</Source>
	<Source>
		<BookingChannel Primary="false">
			<CompanyName Code="CBA">Affiliated Channel</CompanyName>
		</BookingChannel>
	</Source>
</POS>

Element / @Attribute	Type	M	Description
@POS	Element	1	Contains source details.
@Source	Element	1..2	Contains BookingChannel details.
@RequestorID	Element	1	Only present in the first Source element. Identifies the system sending the reservation.
@ID	String	1	Channel code. The ID used will be agreed by trading partners and remain consistent across messages.
@BookingChannel	Element	1	Contains booking channel information.
@Type	Integer	1	Must be set to 4 (ESRP).
@Primary	Boolean	1	true for the primary booking channel in the first Source element. false in the second Source element (if present).
@CompanyName	Element	1	Name of the booking channel.
@Code	String	0..1	Code of the booking channel.

Reservation

<HotelReservations>
	<HotelReservation CreateDateTime="2024-07-06T15:27:41+00:00" LastModifyDateTime="2024-07-06T15:27:41+00:00">
		<UniqueID Type="14" ID="123456789"/>
		<!-- ... other elements and attributes have been omitted for brevity ... -->
	</HotelReservation>
</HotelReservations>

Element / @Attribute	Type	M	Description
HotelReservations	Element	1	Contains the reservation details.
HotelReservation	Element	1	Contains the specific reservation information.
@ResStatus	Enumeration	1	Specifies the current booking status: Reserved Waitlisted Cancelled No-show In-house Checked-Out Redacted
@CreateDateTime	DateTime	1	Date and time when the reservation was first made. Must be set when ResStatus is Commit.
@LastModifyDateTime	DateTime	0..1	Date and time when the reservation was last modified. Must be set when ResStatus is Modify or Cancel.
UniqueID	Element	1	Unique identifier of the reservation in the system which sent the message.
@ID	String	1	Actual confirmation number.

RoomStays

<RoomStays>
	<RoomStay PromotionCode="AUTUNM2024">
		<!-- ... other elements and attributes have been omitted for brevity ... -->
	</RoomStay>
	<!-- Additional RoomStay elements -->
</RoomStays>

Element / @Attribute	Type	M	Description
RoomStays	Element	1	Contains details of all room stays.
RoomStay	Element	1..n	One instance of RoomStay per room type booked.
@PromotionCode	String	0..1	If configured, this is the promotion code indicating, for instance, a specific marketing campaign (not the rate code).
@SourceOfBusiness	StringLen1to64	0..1	To specify where the business came from e.g. radio, newspaper ad, etc.
@MarketCode	StringLen1to64	0..1	The code that relates to the market being sold to (e.g., the corporate market, packages).

RoomTypes

<RoomTypes>
	<RoomType RoomTypeCode="TPL">
		<RoomDescription Name="Triple Room">Triple Bed Room</RoomDescription>
	</RoomType>
</RoomTypes>

Element / @Attribute	Type	M	Description
RoomTypes	Element	0..1	Provides more information about the room type for this room stay.
@RoomType	Element	0..1	Provides details regarding rooms, usually guest rooms. Can be sent to give more information on the room type for this room stay.
@RoomTypeCode	StringLen1to16	0..1	Code of the room booked.
@RoomCategory	Element	0..1	Indicates the category of the room. Typical values would be Moderate, Standard, or Deluxe. Refer to OpenTravel Code List Segment Category Code (SEG).
@RoomID	String	0..1	A string value representing the unique identification of a room if the request is looking for a specific room.
@NonSmoking	Boolean	0..1	Non-smoking indicator.
@Configuration	String	0..1	Textual description of room configuration.
@RoomDescription	String	0..1	Textual information regarding the room.
@Text	String	0..n	A text description of the room
@AdditionalDetails	String	0..1	Container for additional information about this room.
@AdditionalDetail	String	1..n	Required when @AdditionalDetails is present
@Type	Integer	0..1	Used to define the type of information being sent (e.g., rate description, property description, room information). Refer to OpenTravel Code List Additional Detail Type (ADT). Some common usages are: 43: Meal plan information 15: Promotion information
@Code	Integer	0..1	Trading partner code associated to AdditionalDetailType.
@DetailDescription	String	0..1	Textual description of AdditionalDetail information.
@Text	ParagraphType	0..n	A text description of AdditionalDetail

RatePlans

<RatePlans>
	<RatePlan RatePlanCode="BAR">
		<RatePlanDescription>Best Available Rate.</RatePlanDescription>
		<Commission>
			<CommissionPayableAmount Amount="60.00" CurrencyCode="EUR"/>
		</Commission>
		<MealsIncluded MealPlanCode="14"/>
		<!-- Additional MealsIncluded elements -->
	</RatePlan>
</RatePlans>

Element / @Attribute	Type	M	Description
RatePlans	Element	0..1	Provides more information about the rate plan for this room stay.
RatePlan	Element	1	Contains details about the specific rate plan.
@RatePlanCode	String	1	Code of the rate booked.
@RatePlanName	String	0..1	Name of rate plan
RatePlanDescription	Element	0..1	Description of the rate plan.
@Text	String	0..1	Detailed description
RatePlanInclusions	Element	1	Amount of commission to be paid.
@TaxInclusive	Decimal	1	Commission amount.
@ServiceFeeInclusive	String	0..1	Use ISO 4217 currency codes.
RatePlanInclusionDescription	Element	0..n	Used to identify the types of meals included with a rate plan.
Text	Element	0..n	A text description of the RatePlanInclusionDescription
MealsIncluded	Element
@MealPlanIndicator	Boolean		When true, a meal plan is included in this rate plan. When false, a meal plan is not included in this rate plan.
@MealPlanCodes	Integer	0..1	Refer to Meal Plan Type (MPT).
AdditionalDetails	Element		Textual description of AdditionalDetail information.
AdditionalDetail	Element		A text description of AdditionalDetail
@Type	Integer	0..1	Used to define the type of information being sent (e.g., rate description, property description, room information). Refer to OpenTravel Code List Additional Detail Type (ADT). Some common usages are: 43: Meal plan information 15: Promotion information
@Code			Trading partner code associated to AdditionalDetailType.
DetailDescription	Element	0..1	Textual description of AdditionalDetail information.
Text	Element	0..n	A text description of AdditionalDetail

RoomRates

Room Rates

<RoomRates>
	<RoomRate RoomTypeCode="TPL" RatePlanCode="BAR" NumberOfUnits="1">
		<Rates>
			<Rate UnitMultiplier="1" RateTimeUnit="Day" EffectiveDate="2024-10-05" ExpireDate="2024-10-08">
				<Base AmountBeforeTax="558.00" AmountAfterTax="620.00" CurrencyCode="EUR">
					<Taxes>
						<Tax Type="inclusive" Code="35" Amount="62.00" CurrencyCode="EUR"/>
						<!-- Additional Tax elements -->
					</Taxes>
				</Base>
				<Total AmountBeforeTax="558.00" AmountAfterTax="620.00" CurrencyCode="EUR">
					<Taxes>
						<Tax Type="inclusive" Code="35" Amount="62.00" CurrencyCode="EUR"/>
						<!-- Additional Tax elements -->
					</Taxes>
				</Total>
			</Rate>
		</Rates>
		<!-- Additional Rates elements -->
		<ServiceRPHs>
			<ServiceRPH RPH="1"/>
			<!-- Additional ServiceRPH elements -->
		</ServiceRPHs>
	</RoomRate>
</RoomRates>

Same Value per Night

<RoomRates>
	<RoomRate RoomTypeCode="TPL" RatePlanCode="BAR" NumberOfUnits="1">
		<Rates>
			<Rate UnitMultiplier="1" RateTimeUnit="Day" EffectiveDate="2024-10-05" ExpireDate="2024-10-08">
				<Base AmountBeforeTax="558.00" AmountAfterTax="620.00" CurrencyCode="EUR"/>
			<!-- ... other elements and attributes have been omitted for brevity ... -->
			</Rate>
		</Rates>
	</RoomRate>
</RoomRates>

Different Value per Night

<RoomRates>
	<RoomRate RoomTypeCode="TPL" RatePlanCode="BAR" NumberOfUnits="1">
		<Rates>
			<Rate UnitMultiplier="1" RateTimeUnit="Day" EffectiveDate="2024-10-05" ExpireDate="2024-10-06">
				<Base AmountBeforeTax="153.00" AmountAfterTax="170.00" CurrencyCode="EUR"/>
			<!-- ... other elements and attributes have been omitted for brevity ... -->
			</Rate>
			<Rate UnitMultiplier="1" RateTimeUnit="Day" EffectiveDate="2024-10-06" ExpireDate="2024-10-07">
				<Base AmountBeforeTax="180.00" AmountAfterTax="200.00" CurrencyCode="EUR"/>
			<!-- ... other elements and attributes have been omitted for brevity ... -->
			</Rate>
			<Rate UnitMultiplier="1" RateTimeUnit="Day" EffectiveDate="2024-10-07" ExpireDate="2024-10-08">
				<Base AmountBeforeTax="225.00" AmountAfterTax="250.00" CurrencyCode="EUR"/>
			<!-- ... other elements and attributes have been omitted for brevity ... -->
			</Rate>
		</Rates>
	</RoomRate>
</RoomRates>

Combined

<RoomRates>
	<RoomRate RoomTypeCode="TPL" RatePlanCode="BAR" NumberOfUnits="1">
		<Rates>
			<Rate UnitMultiplier="1" RateTimeUnit="Day" EffectiveDate="2024-10-05" ExpireDate="2024-10-07">
				<Base AmountBeforeTax="360.00" AmountAfterTax="400.00" CurrencyCode="EUR"/>
			<!-- ... other elements and attributes have been omitted for brevity ... -->
			</Rate>
			<Rate UnitMultiplier="1" RateTimeUnit="Day" EffectiveDate="2024-10-07" ExpireDate="2024-10-08">
				<Base AmountBeforeTax="198.00" AmountAfterTax="220.00" CurrencyCode="EUR"/>
			<!-- ... other elements and attributes have been omitted for brevity ... -->
			</Rate>
		</Rates>
	</RoomRate>
</RoomRates>

Element / @Attribute	Type	M	Description
RoomRates	Element	1	Contains details of the rates applied to the room stay.
RoomRate	Element	1	One RoomRate per RoomStay. Multiple rates are listed under the RoomRate.
@RoomTypeCode	String	0..1	Specfic system room type code, ex: A1K, A1Q etc.
@RatePlanCode	String	0..1	A string value may be used to request a particular code or an ID if the guest qualifies for a specific rate, such as AARP, AAA, corporate rate, etc., or to specify a negotiated code as a result of a negotiated rate.
@RoomID	StringLen1-128	0..1	A string value representing the unique identification of a room.
@EffectiveDate	Date	1	Starting date of the rate. This date is inclusive.
@ExpireDate	Date	1	Expire date is the first day after the applicable period. This date is not inclusive.
@UnitMultiplier	Integer	0..1	Must be set to 1.
Base	Element	1	The base amount charged for the accommodation or service per unit of time. Mandatory in both OpenTravel Alliance and HTNG if an instance of RoomRate is passed. See Daily Rates Guide.
@AmountBeforeTax	Decimal	0..1	At least one of AmountAfterTax or AmountBeforeTax must be set.
@AmountAfterTax	Decimal	0..1	At least one of AmountAfterTax or AmountBeforeTax must be set.
@CurrencyCode	String	1	Use ISO 4217 currency codes.
Taxes	Element	0..1	Contains details of the taxes applied.
@CurrencyCode	String	1	Use ISO 4217 currency codes.
Tax	Element	0..99	An individual tax per tax element. 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	String	0..1	The type of tax being applied to the total. Refer to the OpenTravel Code List Fee Tax Type (FTT)
@Amount	Decimal	0..1	A monetary amount of tax. if zero, assume use of the Percent attribute (Amount or Percent must be a zero value).
@CurrencyCode	AlphaLength3	0..1	Use ISO 4217 currency codes.
@Percent	Integer	0..1	Tax percentage; if zero, assume the use of the Amount attribute (Amount or Percent must be a zero value).
TaxDescription	Element	0..5	Text description of the taxes.
Text	Element	0..n	Textual description of the tax
Total	Element	1	Total amount charged, including additional occupants and fees. If empty, assume the Base amount equals the Total amount.
@AmountBeforeTax	Decimal	0..1	At least one of AmountAfterTax or AmountBeforeTax must be set.
@AmountAfterTax	Decimal	0..1	At least one of AmountAfterTax or AmountBeforeTax must be set.
@CurrencyCode	AlphaLength3	0..1	Use ISO 4217 currency codes.
Taxes	Element	0..1	Contains details of the taxes applied.
@CurrencyCode	AlphaLength3	0..1	Use ISO 4217 currency codes.
@Amount	Decimal	0..1	Amount of taxes charged
Tax	Element	0..n	Contains specific tax information.
@Code	String	0..1	Indicates the specific tax or fee that is being transferred. Refer to Fee Tax Type (FTT).
@Amount	Integer	0..1	Tax amount applied.
@CurrencyCode	String	0..1	Use ISO 4217 currency codes.
@Percent	Integer	0..1	Tax percentage; if zero, assume the use of the Amount attribute (Amount or Percent must be a zero value).
ServiceRPHs	Element	0..1	Container for the ServiceRPH elements.
ServiceRPH	Element	0..n	Links a service to the Service information at the HotelReservation level (if applicable). Service at the RoomRate level.
@RPH	Integer	1	Reference to the ServiceRPH at the HotelReservation level.

GuestCounts

<GuestCounts>
	<GuestCount AgeQualifyingCode="10" Age="51" Count="1" AgeBucket="AdultOver50"/>
	<GuestCount AgeQualifyingCode="10" Age="44" Count="1" AgeBucket="AdultOver40"/>
	<GuestCount AgeQualifyingCode="8" Age="7" Count="1"/>
	<GuestCount AgeQualifyingCode="8" Age="10" Count="1"/>
	<GuestCount AgeQualifyingCode="7" Count="1"/>
	<!-- Additional GuestCount elements -->
</GuestCounts>

Element / @Attribute	Type	M	Description
GuestCounts	Element	1	Total guest counts, divided by age group (adult, child, infant). Adult count must always be sent.
GuestCount	Element	1..n	Represents the count for a specific age group.
@AgeQualifyingCode	Integer	1	10 = Adult (mandatory) 8 = Child (optional) 7 = Infant (optional)
@Age	Integer	0..1	Age of the guest, required only for children and infants.
@Count	Integer	1	Number of guests for this age group.
@AgeBucket	String	0..1	Defines the age range category or bucket a guest can be booked into. This is typically used in conjunction with the age qualifying code to further define the applicable age range.

TimeSpan

<TimeSpan Start="2024-10-05" End="2024-10-08"/>

Element / @Attribute	Type	M	Description
TimeSpan	Element	1	Contains the timespan for the RoomStay.
@Start	Date	1	Check-in date.
@End	Date	1	Check-out date. (Must be after Start.)

RoomStayTotal

<Total AmountBeforeTax="558.00" AmountAfterTax="620.00" CurrencyCode="EUR">
	<Taxes>
		<Tax Type="inclusive" Code="35" Amount="62.00" CurrencyCode="EUR"/>
		<!-- Additional Tax elements -->
	</Taxes>
</Total>

Element / @Attribute	Type	M	Description
Total	Element	1	Container for the total amount elements.
@AmountBeforeTax	Decimal	0..1	At least one of AmountAfterTax or AmountBeforeTax must be set.
@AmountAfterTax	Decimal	0..1	At least one of AmountAfterTax or AmountBeforeTax must be set.
@CurrencyCode	String	1	Use ISO 4217 currency codes.
Taxes	Element	0..1	Contains details of the taxes applied.
Tax	Element	1..n	Contains specific tax information.
@Type	Enumeration	0..1	Indicates whether the tax is: inclusive exclusive cumulative
@Code	String	0..1	Indicates the specific tax or fee that is being transferred. Refer to Fee Tax Type (FTT).
@Amount	Decimal	0..1	Amount of the tax/fee transferred.
@CurrencyCode	String	0..1	Use ISO 4217 currency codes.

BasicPropertyInfo

<BasicPropertyInfo HotelCode="HOTELCODE" HotelName="The Hotel Name"/>

Element / @Attribute	Type	M	Description
BasicPropertyInfo	Element	1	Contains basic identification details for the hotel associated with the reservation.
@HotelCode	String	1	Identifier for the hotel.
@HotelName	String	0..1	Name of the hotel.

ServiceRPHs

<ServiceRPHs>
	<ServiceRPH RPH="1"/>
	<!-- Additional ServiceRPH elements -->
</ServiceRPHs>

Element / @Attribute	Type	M	Description
ServiceRPHs	Element	0..1	Container for the ServiceRPH elements.
ServiceRPH	Element	1..n	Service at the RoomStay level.
@RPH	Integer	1	Links a Service to the Service information provided at the HotelReservation level (if applicable).

ResGuestRPHs

<ResGuestRPHs>
	<ResGuestRPH RPH="1"/>
	<!-- Additional ResGuestRPH elements -->
</ResGuestRPHs>

Element / @Attribute	Type	M	Description
ResGuestRPHs	Element	0..1	Container for the ResGuestRPH elements.
ResGuestRPH	Element	1..n	Container for the RPH attribute.
@RPH	Integer	1	Links the RoomStay to ResGuest. Find the links in ResGuests.

Comments

<Comments>
	<Comment GuestViewable="true">
		<Text>Platinum Members are offered a free spa entry for the whole length of stay.</Text>
	</Comment>
</Comments>

Element / @Attribute	Type	M	Description
Comments	Element	0..1	Contains comment for the RoomStay.
Comment	Element	1	Holds the actual comment.
@GuestViewable	Boolean	0..1	When true, the comment may be shown to the consumer. When false, the comment may not be shown to the consumer.
Text	Element	1	The content of the comment. PCI sensitive data is prohibited.

SpecialRequests

<SpecialRequests>
	<SpecialRequest Name="Extra Bed">
		<Text>Yes</Text>
	</SpecialRequest>
	<!-- Additional ServiceRPH elements -->
</SpecialRequests>
<SpecialRequests>
	<SpecialRequest RequestCode="Bedding Configuration" CodeContext="GUEST_DIRECT">
		<Text>King Split + Single Bed.</Text>
	</SpecialRequest>
	<SpecialRequest RequestCode="Smoking" CodeContext="CHANNEL">
		<Text>Non-smoking room.</Text>
	</SpecialRequest>
</SpecialRequests>

Element / @Attribute	Type	M	Description
SpecialRequests	Element	1	Contains special requests for the RoomStay.
SpecialRequest	Element	1..n	Holds the actual special request.
@Name	String	1	Special request type (e.g., bedding configuration, smoking, cot, extra bed).
Text	Element	1	Special request text.
@RequestCode	String	0..1	This identifies a special request for this reservation and is typically hotel-specific.
@CodeContext	String	0..1	Identifies the source authority for the RequestCode.

Services

<Services>
	<Service ServiceInventoryCode="EXTRA_BED" Inclusive="true" ServiceRPH="1" Quantity="1" ID="12346">
		<Price>
			<Base AmountBeforeTax="2.50" AmountAfterTax="2.75" CurrencyCode="EUR">
				<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="EUR">
				<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 EUR 2.50 per day for cot</Text>
			</RateDescription>
		</Price>
		<ServiceDetails>
			<TimeSpan Start="2024-10-05" End="2024-10-08"/>
		</ServiceDetails>
	</Service>
	<!-- Additional Service elements -->
</Services>

Element / @Attribute	Type	M	Description
Services	Element	0..1	Contains service details provided to guests.
Service	Element	1..n	Represents a non-room product provided to guests.
@ServiceInventoryCode	String	1	Identifier code for the service. Refer to Service and Extra Charge.
@ServiceRPH	Integer	0..1	Links the Service to a RoomStay or RatePlan. ServiceRPH absence indicates a HotelReservation-level charge.
@Inclusive	Boolean	1	Must be set to TRUE, as SiteConnect reports totals as inclusive of charges and extras.
@ID	String	0..1	Reference ID for the extra/service provided by the source booking channel.
@Quantity	Integer	1	Number of units included in the charge. This value does not affect the total amount.
Price	Element	0..1	Container for pricing details of the service.
Base	Element	1	Base amount charged for the service.
@AmountAfterTax	Decimal	0..1	At least one of AmountAfterTax or AmountBeforeTax must be set.
@AmountBeforeTax	Decimal	0..1	At least one of AmountAfterTax or AmountBeforeTax must be set.
@CurrencyCode	String	0..1	Use ISO 4217 currency codes.
Taxes	Element	0..1	Contains details of the taxes applied.
Tax	Element	1	Contains specific tax information.
@Code		1	Indicates the specific tax or fee that is being transferred. Refer to Fee Tax Type (FTT).
@Percentage	Decimal	0..1	Percentage rate of the applied tax.
@Amount	Decimal	0..1	Tax amount applied.
TaxDescription	Element	0..1	Container for a detailed description of the tax.
Text	Element	1	Text description of the tax.
Total	Element	1	Container for the total amount of the service.
@AmountAfterTax	Decimal	0..1	At least one of AmountAfterTax or AmountBeforeTax must be set.
@AmountBeforeTax	Decimal	0..1	At least one of AmountAfterTax or AmountBeforeTax must be set.
@CurrencyCode		0..1	Use ISO 4217 currency codes.
Taxes	Element	0..1	Contains details of the taxes applied.
Tax	Element	1	Contains specific tax information.
@Code		1	Indicates the specific tax or fee that is being transferred. Refer to Fee Tax Type (FTT).
@Percentage	Decimal	0..1	Percentage rate of the applied tax.
@Amount	Decimal	0..1	Tax amount applied.
TaxDescription	Element	0..1	Container for a detailed description of the tax.
Text	Element	1	Text description of the tax.
RateDescription	Element	0..1	Container for a description of the rate applied to the service.
Text	Element	1	A text description of the service/extra.
ServiceDetails	Element	0..1	Container for additional service details.
TimeSpan	Element	1	Contains the time span for which the service is provided.
@Start	Date	0..1	Start date of service.
@End	Date	0..1	Last date of service.

ResGuests

<ResGuests>
	<ResGuest ResGuestRPH="1" ArrivalTime="14:00:00" PrimaryIndicator="1">
		<Profiles>
			<ProfileInfo>
				<Profile ProfileType="1">
					<Customer>
						<PersonName>
							<NamePrefix>Mr</NamePrefix>
							<GivenName>John</GivenName>
							<Surname>Smith</Surname>
						</PersonName>
						<Telephone PhoneNumber="[phone]"/>
						<Email>[e-mail]</Email>
						<Address>
							<AddressLine>200 George St</AddressLine>
							<AddressLine>Level 3</AddressLine>
							<CityName>Sydney</CityName>
							<PostalCode>2000</PostalCode>
							<StateProv>NSW</StateProv>
							<CountryName>Australia</CountryName>
						</Address>
						<CustLoyalty ProgramID="LoyaltyProgramName" MembershipID="123456789" ExpireDate="2020-12-31"/>
						<Document DocID="987654321P" DocType="5" DocHolderNationality="AU" BirthDate="1996-10-05" Gender="Male" BirthCountry="AU" BirthPlace="AU" EffectiveDate="2015-10-05" ExpireDate="2025-10-05" DocIssueAuthority="The Australian Passport Office" DocIssueLocation="Sydney" DocIssueStateProv="NSW" DocIssueCountry="?">
							<DocHolderName>John Smith</DocHolderName>
						</Document>
					</Customer>
				</Profile>
			</ProfileInfo>
		</Profiles>
	</ResGuest>
	<!-- Additional ResGuest elements -->
</ResGuests>

Element / @Attribute	Type	M	Description
ResGuests	Element	1	Contains the guests for the reservation.
ResGuest	Element	1..n	Contains the specific guest details.
@ResGuestRPH	Integer	0..1	Links the ResGuest to RoomStay. Find the links in ResGuestRPHs.
@AgeQualifyingCode	Integer	0..1	A code representing a business rule that determines the charges for a guest based upon age range (e.g. Adult, Child, Senior, Child With Adult, Child Without Adult). Refer to OpenTravel Code List Age Qualifying Code (AQC).
@ArrivalTime	Time	0..1	Arrival time of the guest.
@PrimaryIndicator	Boolean	0..1	Indicates the primary guest on a reservation: 1 primary guest 0 secondary guests
@Age	Integer	0..1	The age of the guest.
Profiles	Element	1	Contains the guest profile information.
ProfileInfo	Element	1	Contains the profile information for the guest.
UniqueID	Element	0..9	A unique ID for a profile. This element can repeat to accommodate multiple unique IDs for a single profile across multiple systems.
@ID	Integer	1	A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
@Type	Integer	1	A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)
@ID_Context	String	0..1	Used to identify the source of the identifier.
Profile	Element	1	Contains detailed customer profile information.
@ProfileType	Integer	1	Must be set to 1 (Customer).
@ShareAllOptOutInd	Boolean	1	When 'true', a customer has explicitly opted out of marketing communication. This is used in combination with the ShareAllMarketInd and only one of these attributes should have a value of 'true'.
@ShareAllMarketInd	Boolean	1	Permission for sharing all data in profile for marketing purposes. A 'true' value indicates that the customer has chosen to opt-in to marketing communication. This is used in combination with the ShareAllOptOutInd and only one of these attributes should have a value of 'true'.
Customer	Element	0..1	Detailed customer information for this profile.
@VIP_Indicator		0..1	If true, indicates a very important person.
@CustomerValue		0..1	The supplier's ranking of the customer (e.g., VIP, numerical ranking).
@BirthDate		0..1	The customer’s birthday information.
PersonName	Element	0..1	Contains the name information for the guest.
@Language		0..1	The language code for which the name data is represented.
@NameType		0..1	Former, Nickname, Alternate, etc. Please refer to OpenTravel Code List Name Type (NAM)
NamePrefix	Element	0..3	Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)
GivenName	Element	1	First name of the guest.
MiddleName	Element	0..3	The middle name of the person name.
Surname	Element	1	Family or last name of the guest.
NameSuffix	Element	0..3	Name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)
NameTitle	Element	0..5	Degree or honours (e.g., Ph.D., M.D.)
Telephone	Element	0..5	Contains telephone information related to the guest.
@PhoneNumber	String	1	Contains the actual number (maximum 32 characters).
@PhoneLocationType	Integer	0..1	Describes the location of the phone, such as Home, Office, Property Reservation Office, etc. Refer to OpenTravel Code List Phone Location Type (PLT)
@PhoneTechType	Integer	0..1	Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. Refer to OpenTravel Code List Phone Technology Type (PTT).
@CountryAccessCode	Integer	0..1	Code assigned by telecommunications authorities for international country access identifier.
@AreaCityCode	Integer	0..1	Code assigned for telephones in a specific region, city, or area.
@FormattedInd		0..1	Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted.
@DefaultInd		0..1	When true, indicates a default value should be used.
@Remark		0..1	A remark associated with the telephone number.
Email	Element	0..1	Contact email address.
@EmailType	Integer	0..1	Defines the purpose of the e-mail address (e.g. personal, business, listserve). Refer to OpenTravel Code List Email Address Type (EAT).
@DefaultInd	Boolean	0..1	When true, indicates a default value should be used.
Address	Element	0..1	Address information of the guest.
@Type	Integer	0..1	Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT).
AddressLine	Element	0..2	Address lines for the guest.
CityName	Element	0..1	City of residence.
PostalCode	Element	0..1	Postal code.
StateProv	Element	0..1	State or province name.
@StateCode	Integer	0..1	The standard code or abbreviation for the state, province, or region.
PostalCode	Element	0..1	Post Office Code number.
CompanyName	Element	0..1	Country name (maximum 64 characters).
@Code	Integer	0..1	Identifies a company by the company code.
CountryName	String	0..1	Country name (e.g., Ireland).
@Code
@ExpireDate	Date	0..1	Expiry date for this particular membership record in this particular program.
Document	Element	0..1	Detailed document information for the guest.
@DocID	String	1	Unique number assigned by authorities to the document.
@DocType	String	1	Indicates the type of document. Refer to Document Type Code (DOC).
@DocHolderNationality	String	0..1	Country of nationality of the document holder. Use ISO 3166 A-2 country codes.
@BirthDate	Date	0..1	Indicates the date of birth as indicated in the document. Use ISO 8601 date format.
@Gender	String	0..1	Identifies the gender: Female Male Unknown
@BirthCountry	String	0..1	Birth country of the document holder. Use ISO 3166 A-2 country codes.
@BirthPlace	String	0..1	Specifies the birth place of the document holder (e.g., city, state, county, province).
@EffectiveDate	Date	0..1	Indicates the starting date.
@ExpireDate	Date	0..1	Indicates the ending date.
@DocIssueAuthority	String	0..1	Indicates the group or association that granted the document.
@DocIssueLocation	String	0..1	Indicates the location where the document was issued.
@DocIssueStateProv	String	0..1	State or Province where the document was issued.
@DocIssueCountry	String	0..1	Country where the document was issued. Use ISO 3166 A-2 country codes.
DocHolderName	Element	0..1	The name of the document holder in unformatted text (Mr. Sam Jones). If no DocHolderName is included, the guest name fields will be assumed as the holder name.

ArrivalTransport

<ArrivalTransport>
	<TransportInfo Type="Air" ID="QF123" Time="2024-10-05T13:00:00"/>
</ArrivalTransport>

Element / @Attribute	Type	M	Description
ArrivalTransport	Element	0..1	Details about transport to the destination.
TransportInfo	Element	1	Contains transport mode details used by the guest for arrival.
@Type	String	0..1	Type of transport used for arrival, provided by the booking channel.
@ID	String	0..1	Transport provider's ID for the mode of transportation (e.g., Flight Number QF123).
@Time	DateTime	0..1	Arrival time at the destination.

DepartureTransport

<DepartureTransport>
	<TransportInfo Type="Air" ID="QF321" Time="2024-10-08T17:00:00"/>
</DepartureTransport>

Element / @Attribute	Type	M	Description
DepartureTransport	Element	0..1	Details about transport from the destination.
TransportInfo	Element	1	Contains transport mode details used by the guest for departure.
@Type	String	0..1	Type of transport used for departure, provided by the booking channel.
@ID	String	0..1	Transport provider's ID for the mode of transportation (e.g., Flight Number QF123).
@Time	DateTime	0..1	Departure time from the destination.

ResGlobalInfo

<ResGlobalInfo>
	<HotelReservationIDs>
		<HotelReservationID ResID_Type="14" ResID_Value="123456789"/>
	</HotelReservationIDs>
	<!-- ... other elements and attributes have been omitted for brevity ... -->
</ResGlobalInfo>

Element / @Attribute	Type	M	Description
ResGlobalInfo	Element	1	Contains global information about the reservation.
HotelReservationIDs	Element	0..1	Contains the HotelReservationID.
HotelReservationID	Element	1	Reference number/string or PNR as supplied by the booking channel.
@ResID_Type	String	1	Must be set to 14 (Travel Agent PNR).
@ResID_Value	String	1	Actual reference number/string supplied by the booking channel (maximum 64 characters).

ReservationTotal

<Total AmountBeforeTax="120.00" AmountAfterTax="132.00" CurrencyCode="AUD">
	<Taxes CurrencyCode="AUD" Amount="12.00">
		<Tax Code="19" Amount="0" CurrencyCode="AUD" Percent="10">
			<TaxDescription>
				<Text>GST</Text>
			</TaxDescription>
		</Tax>
	</Taxes>
</Total>

Element / @Attribute	Type	M	Description
Total	Element	1	Total amount for the reservation. This includes all RoomStays and any additional fees or charges that apply.
@AmountBeforeTax	Decimal	0..1	At least one of AmountAfterTax or AmountBeforeTax must be set.
@AmountAfterTax	Decimal	0..1	At least one of AmountAfterTax or AmountBeforeTax must be set.
@CurrencyCode	String	1	Use ISO 4217 currency codes.
Taxes	Element	0..1	Contains details of the taxes applied.
@CurrencyCode	String	0..1	Use ISO 4217 currency codes.
@Amount	Decimal	0..1	Tax amount applied.
Tax	Element	1	Contains specific tax information.
@Code	String	0..1	Indicates the specific tax or fee that is being transferred. Refer to Fee Tax Type (FTT).
@Amount	Decimal	0..1	Tax amount applied.
@CurrencyCode	String	0..1	Use ISO 4217 currency codes.
@Percent	Integer	0..1	Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value).
TaxDescription	Element	0..5	Text description of the taxes.
@Text	String	1	Container for detailed description.

Guarantee

Virtual Credit Card

<Guarantee>
	<GuaranteesAccepted>
		<GuaranteeAccepted>
			<PaymentCard CardType="1" CardCode="MC" CardNumber="4321432143214321" SeriesCode="123" ExpireDate="1234">
				<CardHolderName>John Smith</CardHolderName>
				<TPA_Extensions>
					<VirtualCreditCard isVCC="true" VCCActivationDate="2024-09-05" VCCCurrencyCode="EUR" VCCCurrentBalance="620.00" VCCDeactivationDate="2024-10-08"/>
				</TPA_Extensions>
			</PaymentCard>
		</GuaranteeAccepted>
	</GuaranteesAccepted>
</Guarantee>

Credit Card

<Guarantee>
	<GuaranteesAccepted>
		<GuaranteeAccepted>
			<PaymentCard CardType="1" CardCode="MC" CardNumber="4321432143214321" SeriesCode="123" ExpireDate="1234">
				<CardHolderName>John Smith</CardHolderName>
			</PaymentCard>
		</GuaranteeAccepted>
	</GuaranteesAccepted>
</Guarantee>

ThreeDomainSecurity

<Guarantee>
	<GuaranteesAccepted>
		<GuaranteeAccepted>
			<PaymentCard CardType="1" CardCode="MC" CardNumber="4321432143214321" SeriesCode="123" ExpireDate="1234">
				<CardHolderName>John Smith</CardHolderName>
				<ThreeDomainSecurity>
					<Results ThreeDSVersion="1.0.2" XID="z9UKb06xLziZMOXBEmWSVA1kwG0=" CAVV="MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=" ECI="05" />
				</ThreeDomainSecurity>
			</PaymentCard>
		</GuaranteeAccepted>
	</GuaranteesAccepted>
</Guarantee>

Element / @Attribute	Type	M	Description
Guarantee	Element	0..1	Guarantee provided with the reservation. Used if no deposit is paid for the reservation.
@GuaranteeCode		0..1	Guarantee Code
@GuaranteeType		0..1	An enumerated type defining the guarantee to be applied to this reservation. Value: CC/DC/Voucher Deposit DepositRequired GuaranteeRequired None PrePay Profile
GuaranteesAccepted	Element	1	Details of the payment card used for the guarantee.
GuaranteeAccepted	Element	1..n	Guarantee Detail.
@PaymentTransactionTypeCode	String	0..1	This is used to indicate either a charge, reserve (deposit) or refund. charge: This indicates that an actual payment has been made. refund: This indicates that the payment amount of this PaymentDetail element is for a refund. reserve: This indicates that a hold for the indicated amount has been placed on a credit card or that a cash amount has been taken from the customer to guarantee final payment.
@PaymentCard	Element	0..1	Actual credit Specific payment card information. Details of a debit or credit card. NOTE: PCI sensitive information is out of scope in Payment card. Please do not attempt to parse any 'out of scope' elements / data. number.
@CardCode	Integer	0..1	Issuer code. See OTA Payment Card Provider Codes
@EffectiveDate	Integer	0..1	Indicates the starting date (format MMyy).
@ExpireDate	Integer	0..1	The expiry date of the credit card (format MMyy).
CardHolderName	Element	0..1	Name of the cardholder.
CardNumber	Element	0..1	Secure information that supports PCI tokens, data masking and other encryption methods.
@Mask	Integer	0..1	Masked data.
@Token	Integer	0..1	Tokenized information.
@TokenProviderID	String	0..1	Provider ID.
Voucher	Element	0..1	Details of a paper or electronic document indicating prepayment.
@SeriesCode	Integer	0..1	Identification of a series of coupons or vouchers identified by serial number(s).
DirectBill	Element	0..1	Details of a direct billing arrangement.
@DirectBill_ID	Integer	0..1	Identifier for the organization to be billed directly for travel services.
AmountPercent	Element	0..1	Payment expressed as a fixed amount, or a percentage of/or room nights. If the the Total.amountAfterTax is provided, it will be a percentage of this value. If only the amountBeforeTax is provided it will be the percentage of this value. At least @Amount or @Percent will be populated.

DepositPayments

Credit Card

<DepositPayments>
	<GuaranteePayment>
		<AcceptedPayments>
			<AcceptedPayment>
				<PaymentCard CardType="1" CardCode="MC" CardNumber="4321432143214321" SeriesCode="123" ExpireDate="1234">
					<CardHolderName>John Smith</CardHolderName>
				</PaymentCard>
			</AcceptedPayment>
		</AcceptedPayments>
		<AmountPercent Amount="90.00" CurrencyCode="EUR"/>
	</GuaranteePayment>
</DepositPayments>

Deposit Only

<DepositPayments>
	<GuaranteePayment>
		<AmountPercent Amount="90.00" CurrencyCode="EUR"/>
	</GuaranteePayment>
</DepositPayments>

Element / @Attribute	Type	M	Description
Profiles	Element	1	Contains the profiles related to the reservation, including the customer, corporate and/or travel agent.
ProfileInfo	Element	1..3	Contains information about the profile type.
Profile	Element	1	Contains profile details, such as customer, company, or travel agent information.
@ProfileType	String	1	Defines the type of profile: 1 Customer (mandatory) 3 Corporate (optional) 4 Travel Agent (optional)
UniqueID	Element	0..1	Only used for ProfileType 4 (Travel Agent) to identify the unique ID of the agent.
@ID	String	1	Identification number, such as a corporate ID or travel agent ID (e.g., IATA code).
Customer	Element	1	Used for ProfileType 1 to contain customer details.
PersonName	Element	1	Contains the name information for the customer.
NamePrefix	Element	0..1	Title of the customer (e.g., Mr., Mrs., Dr.).
GivenName	Element	1	First name of the customer.
Surname	Element	1	Last name of the customer.
CompanyInfo	Element	1	Used for ProfileType 3 (Corporate) and ProfileType 4 (Travel Agent) to contain company information.
CompanyName	Element	1	Name of the company.
Telephone	Element	0..1	Contains telephone information related to the profile.
@PhoneNumber	String	1	Contains the actual number (maximum 32 characters).
Email	Element	0..1	Contact email address related to the profile.
Address	Element	0..1	Address information for the profile.
AddressLine	Element	0..2	One or more address lines for the profile.
CityName	Element	0..1	City of the profile's residence.
PostalCode	Element	0..1	Postal code of the profile.
StateProv	Element	0..1	State or province of the profile's residence.
CountryName	Element	0..1	Country of the profile's residence (maximum 64 characters).

Response

Examples

Success

<OTA_HotelResNotifRS
	xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="ed8835ff-6198-4f38-b589-3058397f677c" TimeStamp="2024-07-06T15:27:41+00:00" Version="1.0">
	<Success/>
	<HotelReservations>
		<HotelReservation>
			<UniqueID Type="14" ID="123456789"/>
			<ResGlobalInfo>
				<HotelReservationIDs>
					<HotelReservationID ResID_Type="14" ResID_Value="ABC-123456789"/>
				</HotelReservationIDs>
			</ResGlobalInfo>
		</HotelReservation>
	</HotelReservations>
</OTA_HotelResNotifRS>

Error

<OTA_HotelResNotifRS
	xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="ed8835ff-6198-4f38-b589-3058397f677c" TimeStamp="2024-07-06T15:27:41+00:00" Version="1.0">
	<Errors>
		<Error Type="6">Hotel not found for HotelCode=HOTELCODE</Error>
	</Errors>
</OTA_HotelResNotifRS>

Specification

Element / @Attribute	Type	M	Description
OTA_HotelResNotifRS	Element	1	Root element for the response.
@xmlns	String	1	Defines the XML namespace for the request. Will be set to http://www.opentravel.org/OTA/2003/05
@EchoToken	String	1	Unique identifier for the request, used to match requests and responses.
@TimeStamp	DateTime	1	Time when the response was generated.
@Version	String	1	Specifies the API version. Will be set to 1.0.
Success	Element	0..1	Indicates successful processing of the request.
HotelReservations	Element	1	Contains details of the reservation made.
HotelReservation	Element	1	Individual hotel reservation information.
UniqueID	Element	1	Unique identifier for the reservation.
@Type	String	1	Will be set to 14 (Reservation).
@ID	String	1	Actual confirmation number.
ResGlobalInfo	Element	1	Contains global information about the reservation.
HotelReservationIDs	Element	1	Contains the HotelReservationID.
HotelReservationID	Element	1	Reference number/string or PNR.
@ResID_Type	String	1	Will be set to 14 (Travel Agent PNR).
@ResID_Value	String	1	The identifier of the reservation created by SiteConnect.
Errors	Element	0..1	Indicates an error occurred during the processing of the request.
Error	Element	1..n	Single error information containing free text.
@Type	Integer	1	Type of error. Refer to Error Warning Types (EWT).
@Code	Integer	0..1	Code representing the error. Refer to Error Codes (ERR).

Testing and Certification

Error Handling

Glossary