Rates

Message Exchange Workflow

• OTA_HotelRateAmountNotifRQ - request made by SiteConnect to the Booking Channel endpoint.

• OTA_HotelRateAmountNotifRS - response sent by the Booking Channel.

Request

Examples

Request (PDP)

<OTA_HotelRateAmountNotifRQ
	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">
	<RateAmountMessages HotelCode="HOTELCODE">
		<RateAmountMessage>
			<StatusApplicationControl End="2024-10-05" InvTypeCode="SGL" RatePlanCode="BAR" Start="2024-10-05"/>
			<Rates>
				<Rate>
					<BaseByGuestAmts>
						<BaseByGuestAmt AgeQualifyingCode="10" AmountAfterTax="200.00" CurrencyCode="EUR" NumberOfGuests="1"/>
						<BaseByGuestAmt AgeQualifyingCode="10" AmountAfterTax="300.00" CurrencyCode="EUR" NumberOfGuests="3"/>
					</BaseByGuestAmts>
					<AdditionalGuestAmounts>
						<AdditionalGuestAmount AgeQualifyingCode="10" Amount="100" CurrencyCode="EUR"/>
						<AdditionalGuestAmount AgeQualifyingCode="8" Amount="50" CurrencyCode="EUR"/>
					</AdditionalGuestAmounts>
					<RateDescription>
						<Text>Contemporary 1 Bedroom Apartment with private balcony or courtyard.  Large living and dining area with fully equipped kitchen. Features a separate bedroom and bathroom and laundry facilities.</Text>
					</RateDescription>
				</Rate>
			</Rates>
		</RateAmountMessage>
	</RateAmountMessages>
</OTA_HotelRateAmountNotifRQ>

Request (OBP)

<OTA_HotelRateAmountNotifRQ
	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">
	<RateAmountMessages HotelCode="HOTELCODE">
		<RateAmountMessage>
			<StatusApplicationControl End="2024-10-05" InvTypeCode="SGL" RatePlanCode="BAR" Start="2024-10-05"/>
			<Rates>
				<Rate>
					<BaseByGuestAmts>
						<BaseByGuestAmt AgeQualifyingCode="10" AmountAfterTax="100.00" CurrencyCode="EUR" NumberOfGuests="1"/>
						<BaseByGuestAmt AgeQualifyingCode="10" AmountAfterTax="200.00" CurrencyCode="EUR" NumberOfGuests="2"/>
						<BaseByGuestAmt AgeQualifyingCode="10" AmountAfterTax="300.00" CurrencyCode="EUR" NumberOfGuests="3"/>
						<BaseByGuestAmt AgeQualifyingCode="10" AmountAfterTax="400.00" CurrencyCode="EUR" NumberOfGuests="4"/>
						<!-- Additional BaseByGuestAmt elements -->
					</BaseByGuestAmts>
					<AdditionalGuestAmounts>
						<AdditionalGuestAmount AgeQualifyingCode="8" Amount="50" CurrencyCode="EUR"/>
					</AdditionalGuestAmounts>
					<RateDescription>
						<Text>Contemporary 1 Bedroom Apartment with private balcony or courtyard.  Large living and dining area with fully equipped kitchen. Features a separate bedroom and bathroom and laundry facilities.</Text>
					</RateDescription>
				</Rate>
			</Rates>
		</RateAmountMessage>
	</RateAmountMessages>
</OTA_HotelRateAmountNotifRQ>

Specification

Element/Attribute	Type	M	Description
OTA_HotelRateAmountNotifRS	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
@EchoToken	String	1	Unique identifier for the request, used to match requests and responses.
@TimeStamp	DateTime	1	Time when the request was generated.
@Version	String	1	Specifies the API version. Will be set to 1.0.
RateAmountMessages	Element	1	Container for rate status messages.
@HotelCode	String	1	Identifier for the hotel.
RateAmountMessage	Element	1..n	Single rate status message.
StatusApplicationControl	Element	1	Contains date and room identification information.
@Start	Date	1	The start date for which the update is being set. This date is inclusive.
@End	Date	1	The end date for which the update is being set. This date is inclusive.
@InvTypeCode	Integer	1	Identifies the room.
@RatePlanCode	Element	0..1	Identifies the rate.
Rates	String	1	Container for rate information.
Rate	String	1	Contains individual rate information.
BaseByGuestAmts	Element	1	Base charge for a given number of guests.
BaseByGuestAmt	Element	1..n	Contains individual rate amounts.
@AmountAfterTax	Decimal	1	Positive decimal value for the rate amount after tax.
@NumberOfGuests	Integer	0..1	Number of guests in the room. Mandatory for OBP.
@AgeQualifyingCode	Element	0..1	Age qualification for the rate: 10 Adult Mandatory for OBP.
@CurrencyCode	String	0..1	Use ISO 4217 currency codes.
AdditionalGuestAmounts	Element	0..1	Additional charges for extra guests based on age qualification.
AdditionalGuestAmount	Element	0..2	Contains details of extra guest charges.
@AgeQualifyingCode	String	1	Age qualification for the extra guest charge: 10 Adult (only for PDP) 8 Child
@Amount	Decimal	1	Extra charge amount.
@CurrencyCode	String	0..1	Use ISO 4217 currency codes.
RateDescription	Element	0..1	Description of what the rate includes.
Text	Element	1	Inclusion text (maximum 255 characters).

Response

Examples

Success

<OTA_HotelRateAmountNotifRS
	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/>
</OTA_HotelRateAmountNotifRS>

Error

<OTA_HotelRateAmountNotifRS
	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" Code="392">Hotel not found for HotelCode=HOTELCODE</Error>
	</Errors>
</OTA_HotelRateAmountNotifRS>

Specification

Element / @Attribute	Type	M	Description
OTA_HotelRateAmountNotifRS	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. Must be set to 1.0.
Success	Element	0..1	Indicates successful processing of the request.
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).

Help Centre

• Learn about the inventory grid

• Update rates, availability, and restrictions in the inventory grid

• Troubleshoot when inventory is not syncing, or is showing incorrectly on a channel

• Video: Overview of the inventory grid

Testing and Certification

Error Handling

https://github.com/siteminder-au/gitbook/blob/master/sm-published-apis/additional-resources/glossary.md