This message is used for updating the rates.
One OTA_HotelRatePlanNotifRQ message is used to update the rates for a single roomtype for a single rateplan of a single hotel.
Header |
Value |
Content-Type |
text/xml |
SOAPAction |
OTA_HotelRatePlanNotifRQ |
XML Description
OTA_HotelRatePlanNotifRQ
Parameter |
Data Type |
Mandatory? |
Number of occurrences |
Description |
xmlns |
URL |
Yes |
1 |
- |
MessageContentCode |
Integer |
Yes |
1 |
- |
EchoToken |
String |
Yes |
- |
TimeStamp |
- |
Yes |
1 |
- |
Target |
String |
Yes |
1 |
Possible value: Production |
Version |
- |
Yes |
1 |
- |
POS |
Object |
Yes |
1 |
See below |
RatePlans |
Object |
Yes |
1 |
Container object for the RatePlans node. |
POS
Parameter |
Data Type |
Mandatory? |
Number of occurrences |
Description |
Source |
Object |
Yes |
1 |
Identifies information related to the eventual point of sale where the end user is making the booking. For clients selling to the end user, this would be the client reservation confirmation code. For clients selling to other agencies, this should contain the agency's client confirmation code sent to the client API. |
Source
Parameter |
Data Type |
Mandatory? |
Number of occurrences |
Description |
RequestorID |
Object |
Yes |
1 |
Contains the Demand Client code. |
RequestorID
Parameter |
Data Type |
Mandatory? |
Number of occurrences |
Description |
Type |
Integer |
Yes |
1 |
- |
ID |
String |
Yes |
1 |
- |
RatePlans
Parameter |
Data Type |
Mandatory? |
Number of occurrences |
Description |
HotelCode |
String |
Yes |
1 |
Unique hotel ID (Provided by Hotel Trader). |
RatePlan |
Object |
Yes |
1 |
This is a container for RatePlan objects. |
RatePlan
Parameter |
Data Type |
Mandatory? |
Number of occurrences |
Description |
RatePlanCode |
String |
Yes |
1 |
Unique rateplan code provided by Hotel Trader. |
RatePlanType |
Integer |
No |
0 or 1 |
Ignore this attribute. This will be deprecated in future releases. |
Rates |
Object |
Yes |
1 |
This is a container for Rate objects. |
Rates
Parameter |
Data Type |
Mandatory? |
Number of occurrences |
Description |
Rate |
Object |
Yes |
1 - N |
Contains the adult and child prices which are being updated for the specified dates. |
Rate
Parameter |
Data Type |
Mandatory? |
Number of occurrences |
Description |
InvTypeCode |
String |
Yes |
1 |
Unique room code provided by Hotel Trader. |
Sun, Mon, Tue, Wed, Thu, Fri, Sat |
Boolean |
No |
0 or 1 |
Ignore these attributes. They will be deprecated in future releases. |
Start |
String |
Yes |
1 |
The start date for this update. The format is YYYY-MM-DD. |
End |
String |
Yes |
1 |
The end date for this update. The format is YYYY-MM-DD. |
BaseByGuestAmts |
Object |
Yes |
1 |
Contains the prices for all adults. |
AdditionalGuestAmounts |
Object |
No |
0 or 1 |
Contains the prices for additional children. |
RateDescription |
Object |
No |
0 or 1 |
Ignore this node. This will be deprecated in future releases. |
BaseByGuestAmts
Parameter |
Data Type |
Mandatory? |
Number of occurrences |
Description |
BaseByGuestAmt |
Object |
Yes |
1 - N |
Each BaseByGuestAmt node specifies the pricing for the given number of adults. The number of BaseByGuestAmt nodes equals the MaxAdultOccupancy of the roomtype as specified in the metadata file. |
BaseByGuestAmt
Parameter |
Data Type |
Mandatory? |
Number of occurrences |
Description |
AgeQualifyingCode |
String |
Yes |
1 |
Possible value: 10 This attribute serves as an identifier for adult pricing. |
AmountBeforeTax |
Decimal 2 digits after the decimal point |
Yes |
1 |
Refers to how much the guest will pay before tax. This cannot be zero or negative. To know more about the treatment of taxes/fees in this integration refer to the Tax article in our Knowledge Base. |
NumberOfGuests |
Integer |
Yes |
1 |
Refers to the number of adults. |
AdditionalGuestAmounts
AdditionalGuestAmount
Parameter |
Data Type |
Mandatory? |
Number of occurrences |
Description |
AgeQualifyingCode |
Integer |
Yes |
1 |
Possible value: 8. This attribute serves as an identifier for child pricing. |
Amount |
Decimal 2 digits after the decimal point |
Yes |
1 |
The amount before tax charged for each child occupant above the MaxOccupancyForDefaultPrice. This cannot be zero or negative. |
Sample OTA_HotelRatePlanNotifRQ request
<OTA_HotelRatePlanNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" MessageContentCode="8" EchoToken="r-us73hd-ec84-41a3-be33-079d3dc26bd0" TimeStamp="2022-07-06T08:48:20.905Z" Target="Production" Version="1.0">
<POS>
<Source>
<RequestorID Type="22" ID="HotelTrader" />
</Source>
</POS>
<RatePlans HotelCode="TESTHOTELCODE">
<RatePlan RatePlanType="10" RatePlanCode="HTPKG">
<Rates>
<Rate InvTypeCode="KING" Start="2022-07-06" End="2022-07-09" Mon="true" Tue="true" Weds="true" Thur="true" Fri="true" Sat="true" Sun="true">
<BaseByGuestAmts>
<BaseByGuestAmt NumberOfGuests="1" AgeQualifyingCode="10" AmountBeforeTax="161.72" />
<BaseByGuestAmt NumberOfGuests="2" AgeQualifyingCode="10" AmountBeforeTax="171.72" />
<BaseByGuestAmt NumberOfGuests="3" AgeQualifyingCode="10" AmountBeforeTax="185.72" />
<BaseByGuestAmt NumberOfGuests="4" AgeQualifyingCode="10" AmountBeforeTax="192.72" />
</BaseByGuestAmts>
<AdditionalGuestAmounts>
<AdditionalGuestAmount AgeQualifyingCode="8" Amount="10.50" />
</AdditionalGuestAmounts>
<RateDescription />
</Rate>
</Rates>
</RatePlan>
</RatePlans>
</OTA_HotelRatePlanNotifRQ>
Sample success response
An OTA_HotelRatePlanNotifRS object is returned in case of success and errors. See here for more details.