| Info | ||
|---|---|---|
| ||
Please be aware that the Reservation element for the following messages are linked to this page:
|
...
HotelReservation
...
@CreatorID
...
1
...
The user or the office that originated the reservation.
...
...
...
@CreateDateTime
...
1
...
This is the date when the reservation was first made.
...
...
...
@LastModifyDateTime
...
0..1
...
This indicates the last date and time when the reservation was modified. MANDATORY if the ResStatus is “Modify”.
...
...
...
@LastModifierID
...
0..1
...
This indicates the last user who modified the reservation.
...
...
...
@ResStatus
...
1
...
Indicates the current status of the reservation.
Reserved – definitive reservations (‚standard‘ status) and optional reservations (deductive)
Requested – optional reservations (non-deductive)
Waitlisted – reservations on waiting list (non-deductive)
Cancelled – cancelled reservations
No-show – no-show reservations
In-house – checked-in reservations
Checked out – checked-out reservation
...
...
HotelReservation | UniqueID
...
1
...
The unique ID depends on the system generating the booking; i.e., if the booking is generated by the PMS this field would contain the PMS confirmation number; if the system is a CRS, the CRS confirmation number.
...
...
@Type
...
1
...
Defines the type of Reservation ID (e.g. reservation number, cancellation number). Refer to OTA Code List Unique ID Type (UIT).
- 14 - Reservation, ID of reservation
- 27 - Associated shared reservation, ID of other reservation, the room is shared with (only OnPrem)
...
The recommended value for this message is "14" (Reservation).
...
...
...
@ID
...
1
...
ID is the internal confirmation number.
...
...
@ID_Context
...
0..1
...
Used to identify where the ID comes from.
“protelIO”
...
“protelIO”
"CRS"
...
...
...
HotelReservation | RoomStays
...
1
...
A collection of RoomStay objects. Room stays associated with this reservation.
...
...
HotelReservation | RoomStays | RoomStay
...
1
...
Only one instance of RoomStay is allowed.
...
...
@MarketCode
...
0..1
...
This is the abbreviation of the market segment being sold and may be needed by the system for tracking purposes.
...
...
@SourceOfBusiness
...
0..1
...
Used to specify where the business came from; e.g., radio, newspaper ad, or it could be a referring property.
...
...
@PromotionCode
...
0..1
...
A promotion code indicating a specific marketing campaign. Not to be confused with the rate code.
...
...
HotelReservation | RoomStays | RoomStay | RoomTypes
...
0..1
...
A collection of Room Types associated with a particular Room Stay.
...
...
HotelReservation | RoomStays | RoomStay | RoomTypes | RoomType
...
1..n
...
Section could be repeated if there is a room move during the stay.
...
...
@IsRoom
...
1
...
Indicates the room is a sleeping room when true. If false it is a pseudo room reservation.
- "true"
- "false"
...
...
@RoomType
...
0..1
...
Internal room type ID in PMS system.
...
...
@RoomTypeCode
...
1
...
Abbreviated room type.
...
...
@RoomID
...
0..1
...
Room number when allocated.
...
...
@NumberOfUnits
...
1
...
The number of booked rooms.
...
...
HotelReservation | RoomStays | RoomStay | RatePlans
...
0..1
...
The RatePlans element is not required but can be sent to give further details on the rates booked in this reservation.
...
...
HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan
...
1
...
The RatePlan to be booked. This can repeat if multiple rate codes are booked against the reservation
...
...
@RatePlanCode
...
1
...
This is the code of the rate booked.
...
...
@RatePlanID
...
0..1
...
Internal ID of the rate code booked
...
...
@EffectiveDate
...
0..1
...
The Effective date attribute indicates when the specific rate value is applied. This is required reference at those times when there is a rate change during the stay.
yyyy-mm-dd
...
...
@ExpireDate
...
0..1
...
The Expire date indicates the day when the specific value of the rate is changed to another value.
yyyy-mm-dd
...
...
@MarketCode
...
0..1
...
The code that relates to the market being sold to (e.g., the corporate market, packages).
...
...
@PriceViewableInd
...
0..1
...
When true, the price for this rate plan can be viewed by the guest. When false, the guest must contact another entity to obtain price information.
...
...
HotelReservation | RoomStays | RoomStay | RatePlans/ RatePlan | Guarantee
...
0..5
...
Guarantee provided with the reservation.
...
...
@GuaranteeType
...
1
...
This is the attribute that indicates what guarantee is provided with the reservation.
- "CC/ DC/Voucher"
Not supported:
"GuaranteeRequired"
"None"
"Profile"
"Deposit"
"PrePay"
...
...
@GuaranteeCode
...
0..1
...
This is the guarantee code. More specified than @GuaranteeType.
Example: "CC"
...
...
HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | Guarantee | GuaranteeDescription
...
0..1
...
Optional. This can be used to pass the details of the guarantee if the guarantee used is not cc or deposit.
...
...
@Name
...
0..1
...
Used in conjunction with Text element below. The name could be used to indicate Voucher and the Text could be used to indicate the voucher number, for instance.
...
...
HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | Guarantee | GuaranteeDescription | Text
...
0..1
...
Provides text and indicates whether it is formatted or not.
Example: "Credit Card."
...
...
@TextFormat
...
0..1
...
Indicates the format of text used in the description (unformatted or HTML).
Example: "PlainText"
...
...
HotelReservation | RoomStays | RoomStay | RatePlans/ RatePlan | CancelPenalties
...
0..5
...
A collection of cancellation penalty elements
...
...
HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | CancelPenalties | CancelPenalty
...
Defines the hotel cancellation penalty. The CancelPenalty class defines the cancellation policy of the hotel.
...
...
@PolicyCode
...
0..1
...
This is the penalty code.
Example: "48HRS"
...
...
HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | CancelPenalties | CancelPenalty | PenaltyDescription
...
0..1
...
Optional. This can be used to pass additional cancellation policy details.
...
...
@Name
...
0..1
...
Policy Class used in conjunction with the Text element below.
...
...
HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | CancelPenalties | CancelPenalty | PenaltyDescription | Text
...
0..1
...
Provides text and indicates whether it is formatted or not.
Example: "Free cancellation 48hrs before arrival"
...
...
@TextFormat
...
0..1
...
Indicates the format of text used in the description.
Example: "PlainText"
...
...
HotelReservation |RoomStays | RoomStay | RatePlans | RatePlan | RatePlanInclusions
...
1
...
Defines charges that are included in this rate plan.
...
...
@TaxInclusive
...
1
...
Boolean value. Defines if the rate sent is tax inclusive or not.
- "true" - AmountAfterTax
- "false" - AmountBeforeTax
- "true" - AmountAfterTax and AmountBeforeTax
...
protel On-Premise default = "False" (will send AmountBeforeTax values only). This can be changed.
protel Air default = "true" (will send AmountAfterTax values only)
...
...
...
- "1"- Daily
- "6"- Per event
- "12"- Per stay
...
HotelReservation | RoomStays | RoomStay | RoomRates
...
1
...
A collection of Room Rates associated with a particular Room Stay. Each Room Rate combination can have multiple rates. Example King room, Rack rate plan, Monday through Thursday, weekday amount, Friday and Saturday, weekend amount.
...
...
HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate
...
1..n
...
One instance of RoomRate per room/rate/period booked. If more than one Rate plan can be booked in one reservation the entire RoomRate element must be repeated for each Room/rate combination. In addition, all RoomRate elements MUST share the same RoomTypeCode.
...
...
@RoomTypeCode
...
1
...
This is the abbreviation for the room type booked.
...
...
@RoomID
...
0..1
...
Room No. (if already allocated) for the mentioned period.
...
...
@InvBlockCode
...
0..1
...
If the room booked is part of a block, the block ID is transferred in this field.
...
...
@NumberOfUnits
...
1
...
This is the number of rooms booked for the room type code listed in the RoomTypeCode attribute.
In the case of shared reservations, this value will always be "1".
...
...
@RatePlanCode
...
1
...
This is the rate booked for the room type code listed in the RoomTypeCode attribute.
...
...
@RatePlanID
...
0..1
...
Internal ID of the rate code booked
...
...
@BookingCode
...
0..1
...
This is used to indicate the item booked and is primarily used to exchange information with GDSs.
This filed also can be used to display the initially booked room type in case of changing RoomType or reservation move.
...
...
@EffectiveDate
...
0..1
...
Indicates the starting date
yyyy-mm-dd
...
...
@ExpireDate
...
0..1
...
Indicates the ending date.
yyyy-mm-dd
...
...
yyyy-mm-dd
onprem:
- it is possible to set a Option Date, which is later then the Arrival Date → we will display the Option Date as well
- it is possible to set a Option Date, even if the Reservation Status is not optional → we will display the Option date as well for all Reservationsstatus
...
HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | Rates
...
1..n
...
Individual rate amount. This rate is valid for a range of number of occupants and an occupant type.
...
...
HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate
...
1..n
...
At least one instance of Rate per Rate plan. Multiple instances of the Rate element must be sent if rate changes apply to the booking.
...
...
@RateTimeUnit
...
1
...
Rate Time unit is an Enumeration of time units upon which the rate amount is based (e.g., daily, weekly, single rate for full stay).
For protel only ‘Day’ is possible.
...
...
@EffectiveDate
...
1
...
The Effective date attribute indicates the starting date of when the specific rate value is applied.
This is needed when during the stay there are some rate changes.
yyyy-mm-dd
...
...
@ExpireDate
...
1
...
The Expire date indicates the day when the specific value of the rate is changed to another value.
yyyy-mm-dd
...
...
@UnitMultiplier
...
1
...
UnitMultiplier is the number of RateTimeUnits that the rate amount is based upon (e.g., the rate for one day in case of nightly rates). As protel is dealing with days as a unit it should display the number of nights. If it is set to zero the reservation will be a day-use room for the specific date.
...
...
- "true"
- "false"
...
HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate | Base
...
1
...
Information on the Base Rate.
...
...
...
@CurrencyCode
...
1
...
Currency code used ISO 4217 codes to indicate the currency of the rate that is being booked.
...
...
...
@AmountBeforeTax
...
0..1
...
The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).
...
...
...
@AmountAfterTax
...
1
...
The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).
...
...
...
HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate | Total
...
0..1
...
Information on the Total Amount for the certain period of time if it contains more than one night.
...
@CurrencyCode
...
1
...
ISO 4217 codes to indicate the currency of the rate that is being booked.
...
...
...
@AmountBeforeTax
...
0..1
...
The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).
...
...
...
@AmountAfterTax
...
1
...
The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).
...
...
...
HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate | TPA_Extensions | px:RateAmountExtensions
...
Allows extensions to be added to the Open Travel Alliance specification per trading partner agreement.
...
...
@Start
...
0..1
...
Indicates the starting date
yyyy-mm-dd
...
...
@End
...
0..1
...
Indicates the ending date.
yyyy-mm-dd
...
...
HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate | TPA_Extensions | px:RateAmountExtensions | RateAmount
...
...
@AmountBeforeTax
...
0..1
...
The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).
...
...
@AmountAfterTax
...
1
...
The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).
...
...
@RevenueCategoryCode
...
1
...
Code value from OpenTravel Alliance Code List Revenue Category Code (RCC).
- 3 = F&B
- 6 = Extra
- 9 = Logis
- 17 = Total
pAir only:
- 0 = Non-Revenue (net)
- 120 = Non-Revenue (gross)
...
- 3 = F&B
- 6 = Extra
- 9 = Logis
- 17 = Total
...
...
@CurrencyCode
...
1
...
Currency code used ISO 4217 codes to indicate the currency of the rate that is being booked
...
...
onPremise will only display these elements for reservations which are check-in or in the future. For check-out reservations onPremise will not display any amount in the element.
In this element only manual booked fixed charges are displayed.
...
...
...
"true"
"false"
...
...
...
...
...
...
...
...
...
...
...
...
...
@AmountAfterTax
...
...
...
...
@AmountBefore Tax
...
...
...
...
@RevenueCategoryCode
...
Code value from OpenTravel Alliance Code List Revenue Category Code (RCC).
- 3 = F&B
- 6 = Extra
- 9 = Logis
- 17 = Total
pAir Only:
- 0 = Non-Revenue (net)
- 120 = Non-Revenue (gross)
...
...
3 = F&B
6 = Extra
9 = Logis
17 = Total
...
...
...
@CurrencyCode
...
...
...
...
...
...
Indicates that the guest count provided is on a per room basis.
...
...
...
Contains the type and number of guests included in the reservation.
...
- If a AQC is part of the message pAir will evalute against the AQC
- If the AQC is missing pAir will evalute against the Age
- If both are missing, pAir treats GuestCounts as Adult
...
@AgeQualifyingCode
...
@Count
...
- Name="MarketCode"
- Name="SourceOfBusiness"
...
...
HotelReservation | RoomStays | RoomStay | GuestCounts
...
1
...
Contains the guest counts of the booking.
...
...
@IsPerRoom
...
0..1
...
Indicates that the guest count provided is on a per room basis.
- "true"
- "false"
...
...
HotelReservation | RoomStays | RoomStay | GuestCounts | GuestCount
...
1..n
...
Contains the type and number of guests included in the reservation.
...
...
@AgeQualifyingCode
...
1
...
AgeQualifyingCode = 10 (Adult)
Applicable for onPrem:
Child 1 --> AgeQualifyingCode = 7 (Infant)
Child 2 --> AgeQualifyingCode = 8 (child)
Child 3 --> AgeQualifyingCode = 9 (teen)
Child 4 --> AgeQualifyingCode = 19 (Junior)
Applicable for pAir:
AgeQualifyingCode = 7 (Infant)
AgeQualifyingCode = 8 (Child)
AgeQualifyingCode = 9 (Teenager)
...
...
...
@Count
...
1
...
The count will include the number and will be repeated for each Type of guest.
...
...
HotelReservation | RoomStays | RoomStay | TimeSpan
...
1
...
These are the in and out dates of the booking.
...
...
@Start
...
1
...
Arrival date
yyyy-mm-dd
...
Arrival date and arrival time
yyyy-mm-dd
the "Thh:mm" will be used for the Arrival Time
...
...
...
@End
...
1
...
Departure date
yyyy-mm-dd
...
Departure date and departure time
yyyy-mm-dd
the Thh:mm will be used for the Departure Time
...
...
...
This is the attribute that indicates what guarantee is provided with the reservation.
- "CC/ DC/Voucher"
Not supported:
"GuaranteeRequired"
"None"
"Profile"
"Deposit"
"PrePay"
...
This is the guarantee code. More specified than @GuaranteeType .
Example: "CC"
...
Payment card type.
- "1" Credit
- "2" Debit
- "3" Central bill
...
Provides text and indicates whether it is formatted or not.
Example: "Credit Card."
...
Indicates the format of text used in the description (unformatted or HTML).
Example: "PlainText"
...
This is the penalty code.
Example: "48HRS"
...
Indicates the format of text used in the description.
Example: "PlainText"
...
HotelReservation | RoomStays | RoomStay | Total
...
0..1
...
This is the total amount for the stay.
...
...
...
@CurrencyCode
...
1
...
ISO 4217 codes to indicate the currency of the rate that is being booked.
...
...
...
@AmountBeforeTax
...
0..1
...
The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).
...
...
...
@AmountAfterTax
...
1
...
The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).
...
...
...
HotelReservation | RoomStays | RoomStay | TPA_Extension | px:RateAmountExtensions
...
0..1
...
...
@Start
...
1
...
Indicates the starting date
yyyy-mm-dd
...
...
@End
...
1
...
Indicates the ending date.
yyyy-mm-dd
...
...
"true"
"false"
...
...
HotelReservation | RoomStays | RoomStay | TPA_Extensions | px:RateAmountExtensions | px:RateAmount
...
0..1
...
...
@AmountAfterTax
...
1
...
The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).
...
...
@AmountBefore Tax
...
1
...
The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).
...
...
@RevenueCategoryCode
...
1
...
Code value from OpenTravel Alliance Code List Revenue Category Code (RCC).
...
- 3 = F&B
- 6 = Extra
- 9 = Logis
- 17 = Total
pAir Only:
- 0 = Non-Revenue (net)
- 120 = Non-Revenue (gross)
...
3 = F&B
6 = Extra
9 = Logis
17 = Total
...
...
...
@CurrencyCode
...
1
...
Currency code used ISO 4217 codes to indicate the currency of the rate that is being booked
...
...
onPremise will only display these elements for which are check-in or in the future. For check-out reservations onPremise will not display any amount in the element.
In this element only manual booked fixed charges are displayed.
...
"true"
"false"
...
...
...
...
...
@AmountAfterTax
...
@AmountBefore Tax
...
@RevenueCategoryCode
...
Code value from OpenTravel Alliance Code List Revenue Category Code (RCC).
...
- 3 = F&B
- 6 = Extra
- 9 = Logis
- 17 = Total
pAir Only:
- 0 = Non-Revenue (net)
- 120 = Non-Revenue (gross)
...
3 = F&B
6 = Extra
9 = Logis
17 = Total
...
@CurrencyCode
...
HotelReservation | RoomStays | RoomStay | ResGuestRPHs
...
1
...
A collection of unsigned integers serving as reference placeholders, and used as an index identifying which guests occupy this room
...
...
HotelReservation | RoomStays | RoomStay | ResGuestRPHs | ResGuestRPH
...
1..n
...
This is a reference placeholder, used as an index for this guest in this reservation. In the ResGuest object it is used like all other RPH attributes to send the delta of a reservation. It is used by the RoomStay and Service objects to indicate which guests are associated with that room stay or service.
...
...
@RPH
...
1
...
Used to refer to the guest associated with this reservation.
If profiles for guest, travel agency and company are available in the message, they would all have a separate entry per profile type.
...
...
HotelReservation | RoomStays | RoomStay | Comments | Comment
...
1
...
Comment details.
...
...
@GuestViewable
...
0..1
...
This indicates that the comment can actually be seen by the guest and is necessary when two different types of comments are passed: one that is guest viewable and one that isn’t. The Attribute is of Boolean nature.
...
pAir: for the ResStatus="Commit" we will save the comment, for the ResStatus="Modify" not.
We will only save the Comments for "Commit" otherwise it is possible that we will overwrite existing Comments made by the hotel
onPremise: it is configurable
...
...
...
HotelReservation | RoomStays | RoomStay | Comments | Comment | Text
...
1
...
Comments.
...
...
@TextFormat
...
1
...
HTML versus Plain Text.
Example: "PlainText"
...
...
Used to specify how the amount needs to be applied with respect to the stay
FirstNightDeposit =
"Amount to be applied as a deposit for the first night."
...
...
...