1.4 Booking Quote Request and Response
Overview
This article will take you through the elements of a Booking Quote Request and Response.
Feature
The booking quote request allows you to obtain a quote for a specific online booking.
IMPORTANT NOTE: The API will return a quote for a charge type regardless of minimum / maximum nights restrictions. The developer should filter relevant charge types based on minimum / maximum night restrictions returned as part of the RMSAvailRateChartRQ.
Request Elements
| Element Name | Parent Element | Element Description | Attributes | Required |
|---|---|---|---|---|
| RMSQuoteRQ | Root element. Containing the request for a booking quote. | Version - document version of the response schema. | Yes | |
| AgentId | RMSQuoteRQ | The agent code of the RMS agent enquiring. | Yes | |
| RMSClientId | RMSQuoteRQ | The RMS Client Id of the property being searched. | Yes | |
| Quotes | RMSQuoteRQ | Contains one or multiple booking quotes | Yes | |
| Quote | Quotes | Represents one booking quote | Yes | |
| QuoteItem | Quote | Contains details of the booking quote | Yes | |
| RoomTypeId | QuoteItem | The identity of the requested room types | Yes | |
| AreaId | QuoteItem | The identity of the requested area. | No | |
| UseAreaSpareFieldLookup | QuoteItem | If supplied, uses specified spare field to search for Area using the value in SpareFieldValue, Ignored if AreaId is supplied. | No | |
| AreaSpareFieldValue | QuoteItem | Value to search for in spare field. | No | |
| NoOfRooms | QuoteItem | Number of rooms required under this room type. Optional element use either AreaId or NoOfRooms. | No | |
| Overridden | QuoteItem | Used if the price will be overridden manually or no price is required in RMSQuoteRS | No | |
| ChargeTypeId | QuoteItem | The identity of the charge type used against the booking. Not required if Overridden element is present. Exluding it will cause Price element in RMSQuoteRS to be blank. | Yes | |
| PromoCode | QuoteItem | Used to place a promotional discount against the price | No | |
| PromoCodeSecond | QuoteItem | Used to place a second promotional discount against the price. Used in conjunction with PromoCode | No | |
| ArrivalDate | QuoteItem | The day which the guest will arrive. | Yes | |
| DepartureDate | QuoteItem | The day which the guest will depart. | Yes | |
| Adults | QuoteItem | Number of adults for rate calculation. | Yes | |
| Children | QuoteItem | Number of children for rate calculation. | Yes | |
| Infants | QuoteItem | Number of infants for rate calculation. | Yes | |
| Additionals1 | QuoteItem | Number of first additionals for rate calculation. | No | |
| Additionals2 | QuoteItem | Number of second additionals for rate calculation. | No | |
| Additionals3 | QuoteItem | Number of third additionals for rate calculation. | No | |
| Additionals4 | QuoteItem | Number of fourth additionals for rate calculation. | No | |
| Additionals5 | QuoteItem | Number of fifth additionals for rate calculation. | No | |
| Test | Quote | Optional element. If present, points to the test data for a property. | No | |
| Requirements | Quote | Contains any additional requirements chosen by the guest. | No | |
| Requirement | Requirements | A specified additional requirment. | No | |
| Id | Requirement | The identifier of the requirement. | No | |
| Name | Requirement | The requirement name. | No | |
| Quantity | Requirement | The quantity of the requirement requested. | No | |
| Amount | Requirement | The amount charged for the requirement(s). | No | |
| Sundry_Id | Requirement | The identifier of the sundry charge assosiated. | No | |
| ExcludeAmountFromDeposit | Requirement | Should the Requirement Amount be Excluded from the Deposit Calculation | No | |
| From | Requirement | The date the requirement begins. If left out it will default to the booking arrival. | No | |
| To | Requirement | The date the requirement ends. If left out it will default to the booking departure. | No |
Example Request
<RMSQuoteRQ>
<RMSClientId>3038</RMSClientId>
<AgentId>1</AgentId>
<Quotes>
<Quote>
<QuoteItem>
<RoomTypeId>1</RoomTypeId>
<NoOfRooms>1</NoOfRooms>
<ChargeTypeId>1</ChargeTypeId>
<PromoCode>*DGetaway</PromoCode>
<PromoCodeSecond>*DGetaway2</PromoCodeSecond>
<BookingSourceId></BookingSourceId>
<ArrivalDate>2014-08-25T00:00:00</ArrivalDate>
<DepartureDate>2014-08-28T00:00:00</DepartureDate>
<Adults>2</Adults>
<Children>0</Children>
<Infants>0</Infants>
<Additionals1>0</Additionals1>
<Additionals2>0</Additionals2>
<Additionals3>0</Additionals3>
<Additionals4>0</Additionals4>
<Additionals4>0</Additionals4>
<CurrencyId>5</CurrencyId>
</QuoteItem>
<Requirements>
<Requirement>
<Id>2</Id>
<Name>Full Breakfast</Name>
<Quantity>1</Quantity>
<Sundry_Id>3</Sundry_Id>
<ExcludeAmountFromDeposit>true</ExcludeAmountFromDeposit>
<Amount>15.00</Amount>
</Requirement>
</Requirements>
</Quote>
</Quotes>
</RMSQuoteRQ>
Response Elements
| Element Name | Parent Element | Element Description | Attributes |
|---|---|---|---|
| RMSQuoteRS | Root element. Containing the response to a booking quote request. | Version - document version of the response schema. | |
| UID | RMSQuoteRS | Unique identifier for the quote. | |
| TotalTotal | RMSQuoteRS | Total charge for the tariff part of the quote excluding requirements and discounts. | |
| TotalDiscount | RMSQuoteRS | Total of any discounts applied | |
| TotalPrice | RMSQuoteRS | Total charge for the tariff part of the quote after discounts have been applied | |
| TotalRequirements | RMSQuoteRS | Total charge for the requirements in the quote | |
| TotalDeposit | RMSQuoteRS | Deposit required for the quote (includes tariff, requirements and any other fees) | |
| TotalDepositTax | RMSQuoteRS | Tax amount required on the deposit for the quote. | |
| TotalTax | RMSQuoteRS | The total tax amount of the totaltotal element. | |
| BookingFee | RMSQuoteRS | The amount to charge for the booking fee. | |
| CCFees | RMSQuoteRS | The amount to charge for the credit card fees. | |
| Quotes | RMSQuoteRS | Contains quote responses for each quote sent in request. | |
| Quote | Quotes | Specified Quote. | |
| QuoteItem | Quote | Contains details of the booking Quote | |
| RoomTypeId | QuoteItem | The identity of the requested room type. | |
| AreaId | QuoteItem | The identity of the requested area. Optional element use either AreaId OR NumberOfRooms. | |
| NumberOfRooms | QuoteItem | Number of rooms required under this room type. Optional element use either AreaId OR NumberOfRooms. | |
| ChargeTypeId | QuoteItem | The identity of the charge type used against the booking. | |
| BookingSourceId | QuoteItem | Identifier for the booking source for the request received. | |
| ArrivalDate | QuoteItem | The day which the guest will arrive. | |
| DepartureDate | QuoteItem | The day which the guest will depart. | |
| Adults | QuoteItem | Number of adults for rate calculation. | |
| Children | QuoteItem | Number of children for rate calculation. | |
| Infants | QuoteItem | Number of infants for rate calculation. | |
| Additionals1 | QuoteItem | Number of first additionals for rate calculation. | |
| Additionals2 | QuoteItem | Number of second additionals for rate calculation. | |
| Additionals3 | QuoteItem | Number of third additionals for rate calculation. | |
| Additionals4 | QuoteItem | Number of fourth additionals for rate calculation. | |
| Additionals5 | QuoteItem | Number of fifth additionals for rate calculation. | |
| CurrancyId | QuoteItem | The identifier of the currency of the quote. | |
| QuotedPrice | Quotes | Contains the quote detailed pricing. | |
| Currency | QuotedPrice | The properties preferred currency. | |
| OriginalPrice | QuotedPrice | The original amount before discounts (if any). | |
| Tax | QuotedPrice | The tax portion of the quote. | |
| Discount | QuotedPrice | The amount to be discounted from original | Id = The identifier of the discount to be used in the BookingRQ |
| Price | QuotedPrice | The price for the tariff part of the booking after discounts are applied. | |
| Requirements | QuotedPrice | The price for the requirements of the booking. | |
| Deposit | QuotedPrice | The deposit required for the booking | |
| DepositTax | QuotedPrice | Tax element of the deposit required | |
| DepositIncTax | QuotedPrice | Deposit amount plus tax | |
| RefundableCharge | QuotedPrice | The amount refundable to the guest on arrival | Name = The name of the refundable charge. |
| NightlyBreakdown | QuotedPrice | ||
| Night | NightlyBreakdown | Represents nightly rate of the booking quote. | Id = Identifies the night entry Date = The date represented by the night of this entry Price = The nightly rate for this entry.
Nightly breakdown of the element Price. |
| Unavailable | QuotedPrice | This element will be present if quote request has no inventory to place a booking. | |
| NoRate | QuotedPrice | This element will be present if quote request returns no rates for the specified period. | |
| Requirements | Quotes | Contains any additional requirements chosen by the guest. | |
| Requirement | Requirements | A specified additional requirement. | |
| Id | Requirement | The identifier of the requirement. | |
| Name | Requirement | The requirement name. | |
| Quantity | Requirement | The quantity of the requirement requested. | |
| Amount | Requirement | The amount charged for the requirement(s). | |
| Sundry_Id | Requirement | The identifier of the sundry charge assosiated. | |
| ExcludeAmountFromDeposit | Requirement | Should the Requirement Amount be Excluded from the Deposit Calculation | |
| From | Requirement | The date the requirement begins. If left out it will default to the booking arrival. | |
| To | Requirement | The date the requirement ends. If left out it will default to the booking departure. |
Example Response
<RMSQuoteRS>
<UID>2708826</UID>
<TotalTotal>43.50</TotalTotal>
<TotalDiscount>0.00</TotalDiscount>
<TotalPrice>43.50</TotalPrice>
<TotalRequirements>15.00</TotalRequirements>
<TotalDeposit>0.00</TotalDeposit>
<TotalDepositTax>0.00</TotalDepositTax>
<TotalDepositIncTax>0.00</TotalDepositIncTax>
<TotalTax>0.00</TotalTax>
<BookingFee>1.10</BookingFee>
<CCFees>3.00</CCFees>
<Quotes>
<Quote>
<QuoteItem>
<RoomTypeId>1</RoomTypeId>
<NoOfRooms>1</NoOfRooms>
<ChargeTypeId>1</ChargeTypeId>
<BookingSourceId></BookingSourceId>
<ArrivalDate>2014-08-25T00:00:00</ArrivalDate>
<DepartureDate>2014-08-28T00:00:00</DepartureDate>
<Adults>2</Adults>
<Children>0</Children>
<Infants>0</Infants>
<Additionals1>0</Additionals1>
<Additionals2>0</Additionals2>
<Additionals3>0</Additionals3>
<Additionals4>0</Additionals4>
<Additionals4>0</Additionals4>
<CurrencyId>5</CurrencyId>
</QuoteItem>
<Requirements>
<Requirement>
<Id>2</Id>
<Name>Full Breakfast</Name>
<Quantity>1</Quantity>
<Sundry_Id>3</Sundry_Id>
<ExcludeAmountFromDeposit>true</ExcludeAmountFromDeposit>
<Amount>15.00</Amount>
</Requirement>
</Requirements>
<QuotedPrice>
<CurrencySymbol>AUD</CurrencySymbol>
<OriginalPrice>43.50</OriginalPrice>
<Tax>0.00</Tax>
<Discount Id="0">0.00</Discount>
<Price>43.50</Price>
<Requirements>15.00</Requirements>
<Deposit>0.00</Deposit>
<DepositTax>0.00</DepositTax>
<DepositIncTax>0.00</DepositIncTax>
<RefundableCharge Name="">0.00</RefundableCharge>
<NightlyBreakdown>
<Night Id="1" Date="2014-08-25" Price="14.50" />
<Night Id="2" Date="2014-08-26" Price="14.50" />
<Night Id="3" Date="2014-08-27" Price="14.50" />
</NightlyBreakdown>
</QuotedPrice>
</Quote>
</Quotes>
</RMSQuoteRS>
Related
- RMS Online API
- This guide provides an overview of product features and related technologies. In addition, it contains recommendations on best practices, tutorials for getting started, and troubleshooting information for common situations.
- 1.1 Property Details Request and Response
- This article will take you through the elements of a Property Details Request and Response.
- 1.2 Room Type Details Request and Response
- This article will take you through the elements of a Room Type Request and Response.
- 1.3 Availability Rates Request and Response
- This article will take you through the elements of a Availability / Rates Request and Response.
- 1.5 Booking Request and Response
- This article will take you through the elements of a Booking Request and Response.
- 1.6 Booking Cancel Request and Response
- This article will take you through the elements of a Booking Cancel Request and Response.
- 2.1 Terms and Definitions
- This article will take you through the terms and definitions of the RMS Online Schema.
- RMS API Technical Information
- This article will provide your web page developer the technical information required to write to the RMS API Schema.
Classifications
- © Copyright 2015 RMS