Retrieve Reservations

OTA_ReadRQ

1

Root element

@EchoToken

1

Globally unique identifier for the request, value will be returned as an EchoToken in the response.

@TimeStamp

1

Time of the transaction in xml schema dateTime format. Format like yyyy-MM-dd'T'HH:mm:ssZZ, (i.e '2021-03-09T20:05:52+08:00')

@Type

1

Fixed at 22 (ESRP)

@ID

1

The ID used will be agreed by the trading partners and remain the same throughout the messages.

OTA_ReadRQ / ReadRequests

1

ReadRequests / HotelReadRequest

1

@HotelCode

0..1

Hotel code as recognised by pmsXchange. If omitted all reservations for the PMS will be returned.
Note: This attribute is only optional for central property management systems. It is mandatory for on-site systems.

HotelReadRequest / SelectionCriteria

1

@SelectionType

1

Must be "Undelivered"

OTA_ResRetrieveRS

Time of the transaction in xml schema dateTime format.

Mandatory if Error present.
Any type from the OTA code table for 'Error Warning Type (EWT)' can be used. In particular, the following types are used

3: Biz rule (The business rules for the request message were not met)
4: Authentication error (If username and password are not authenticated)
6: Authorization error (If authenticated username is not authorized to alter hotel data)
10: Required field missing (If xml does not meet the schema, i.e missing request fields or invalid data types.)

Any code from the OTA code table for 'Error Codes (ERR)' can be used.

At least one reservation element if ReservationList exists

See HotelReservationType

@CreateDateTime

1

This is the date when the reservation was first made. Mandatory if ResStatus is "Book".

@ResStatus

1

Status is "Book", "Modify" or "Cancel"

HotelReservation / UniqueID

1..2

The reservation reference in PmsXchange.

The first UniqueID element will contain the unique identifier for the entire reservation. This identifier will identify the reservation through any subsequent modifications or cancellations.

The second UniqueID element with ID_Context="MESSAGE_UNIQUE_ID" is the unique id for this message. This identifier should be used to confirm the message once processed

@Type

1

Value '14' is the unique id for the reservation in Siteminder. Value '16' is the unique id for the message transferring the reservation.

@ID

1

Identifier of the reservation according to PmsXchange. Note, this is NOT the reservation id according to the upstream system. This is located in the HotelReservationID element.

There is the possiblility that this ID will contain special characters such as '/'.

POS / Source

1..2

Source of the reservation. A second POS / Source node can be present to define a secondary channel source.

@Type

1

Fixed at 22 (ESRP)

@ID

1

Value is always 'SITEMINDER'

Name of the Booking Channel.

NOTE: This name is subject to change/variation by the Booking Channel. Please use the @Code attribute below to identify Booking Channels on incoming reservations.

@Code

0..1

PmsXchange's code to identify the Booking Channel. See the OTA Booking Agent Code Table for reference. For secondary channels this code may not be available, when present it will be the secondary channel code as provided by the source channel.

HotelReservation / RoomStays / RoomStay

0..n

One instance of RoomStay per room booked.
A RoomStay element will always exist if ResStatus is "Book" or "Modify".
If ResStatus is "Cancel" it is possible that no RoomStay element exists. 

See RoomStayType

HotelReservation / ResGuests / ResGuest

0..n

One instance of ResGuest per reservation guests. This guest information is dependent on the sometimes limited information retrieved from the booking agents. ResGuests might not always be directly linkable to the RoomStays. Either all ResGuests are linked to RoomStays or none are.

See ResGuestType

A list of service fees and extra charges linked to the HotelReservation

See ServiceType

HotelReservation / ResGlobalInfo

1

Contains general information about the Reservation
See ResGlobalInfo

HotelReservationIDs / HotelReservationID

0..2

Reference number/string or PNR as supplied by the Booking agent will be supplied here. If this reservation is linked under an itinerary, the itinerary id given by the source booking agent will be supplied in a second.

@ResID_Type

1

Will be sent as 14 or 26.

14: OTA code for 'Travel Agent PNR'. If this type is used the @ResID_Value will be the reservation identifier as provided by the source booking channel.

26: OTA code for 'Associated itinerary reservation'. If this type is used the @ResID_Value will be the itinerary identifier for one or more bookings in an itinerary as provided by the source booking channel.

@ResID_Value

1

Reference number/string supplied by the Booking agent. ResID_Value could potentially contain special characters such '/'.

Total

0..1

The total amount for the Reservation. Will add up to the sum of the RoomStay totals PLUS any additional fees sent by the BookingAgent.

NOTE: It is possible that some OTAs do not provide any form of Rate information. As such we cannot guarantee Rate information will be provided. Currently Hotelbeds (HBD) is a known channel that does not always provide Rate information.

See TotalType

This is a listing of Profiles associated with the reservation that are not Guests. This includes Customers, Travel Agents and Travel Arrangers. The Customer is the contact person for the Reservation. If the customer is also a guest, they will also be included in the ResGuest profile.

See ProfilesType

0..n

A container for added fees

@TaxInclusive

1

If 'true' the commission amount provided is tax inclusive, if 'false' the commission amount is not tax inclusive

@Type

1

Always 'Inclusive' as PmsXchange reports gross Totals. Totals are inclusive of fees

0..1

Identifies the type of fee. Current values allowed are

Commission: Commission against the total of the reservation.

A description of the fee

@Amount

0..1

The deposit as a currency amount. At least @Amount or @Percent will be populated.

Guarantee information

See GuaranteeType

Holds information about the Hotelier which this reservation is for.

BasicPropertyInfo will always be sent as either part of the RoomStay or Retrieve Reservations#ResGlobalInfo, depending on your setup in pmsXchange. We recommend receiving the BasicPropertyInfo as part of the ResGlobalInfo due to how Booking.com cancellation messages are sent.

@ResGuestRPH

0..1

This value links the ResGuest to RoomStay(s) where possible. You can find the links in RoomStay / ResGuestRPHs. 

@ArrivalTime

0..1

The arrival time of the guest in the form HH:mm:ss.

ResGuest / Profiles

1

Contains the guest profile information

See ProfilesType

Identifier for the comment, current supported names are

ArrivalDetails: Details about the guest's mode of arrival
DepartureDetails: Details about the guest's mode of departure 

@PromotionCode

0..1

If configured, this is the promotion code indicating, for instance, a specific marketing campaign – not the rate code.

@SourceOfBusiness

0..1

To specify where the business came from e.g. radio, newspaper ad, etc.

Container for additional information about this room provided by the source channel

See AdditionalDetailsType

Container for additional information for the room provided by the source channel

See AdditionalDetailsType

RoomStay / RoomRates / RoomRate

1..n

Multiple RoomRates per RoomStay. Multiple rates are listed under each RoomRate. This can happen when there is a single room booked but more than one rate plan applies during the stay.

See RoomRateType

RoomStay / GuestCounts / GuestCount

0..3

How many guests will be staying in the room. The count is split over potentially three GuestCount elements under GuestCounts, one for each type of guest: adult, child or infant.

@AgeQualifyingCode

1

Specifies the guest type for this GuestCount - uses OTA Spec for identifiers, will be one of three values
10 - Adult
8 - Child
7 - Infant

@Count

1

The actual count for this type of guest

RoomStay / TimeSpan

1

Contains the timespan which this RoomStay covers

@Start

1

Check in date

@End

1

Check out date

RoomStay / Total

0..1

The total amount of the RoomStay. Will add up to the sum of Rate / Total*NumberOfUnits. If no Rate / Total is present, will be the sum of Rate / Base*NumberOfUnits plus any additional costs, such as fees/services etc. IE The total cost for the RoomStay.

NOTE: It is possible that some OTAs do not provide any form of Rate information and as such a RoomStay / Total cannot be provided in such cases. Currently Hotelbeds (HBD) is a known channel that does not always provide Rate information.

See TotalType

RoomStay / BasicPropertyInfo

0..1

Holds information about the Hotelier which this reservation is for.

BasicPropertyInfo will always be sent as either part of the RoomStay or Retrieve Reservations#ResGlobalInfo, depending on your setup in pmsXchange. We recommend receiving the BasicPropertyInfo as part of the ResGlobalInfo due to how Booking.com cancellation messages are sent.

If you are requesting reservations for all your hotels, using a single OTA_ReadRQ (centralised) we recommend using ResGlobal / BasicPropertyInfo / @HotelCode.

@HotelCode

1

The code for the Hotel for which the booking was made.

RoomStay / ResGuestRPHs / ResGuestRPH

0..n

Used to link guests from the ResGuests list to the RoomStay

@RPH

1

Links a ResGuest/@ResGuestRPH to this RoomStay

RoomStay / Comments / Comment / Text

0..1

RoomStay comments

RoomStay / RoomRates / RoomRate

1..n

Multiple RoomRates per RoomStay. Multiple rates are listed under each RoomRate. This can happen when there is a single room booked but more than one rate plan applies during the stay.

@RoomTypeCode

1

The code of the room booked

@NumberOfUnits

1

Always 1. Each room will be listed in it's own RoomStay element.

@RatePlanCode

1

This is the rate booked for the room type code listed in the RoomTypeCode attribute.

RoomRate / Rates

0..1

Container for the daily rate breakdown information, if none was provided by the channel this will be omitted

@RateTimeUnit

1

Always "Day"

@EffectiveDate

1

The starting date of the rate in the form yyyy-MM-dd. This date is inclusive.

@ExpireDate

1

ExpireDate is the first day after the applicable period (e.g. when expire date is 2012-04-03 the last date of the period is 2012-04-02). Format yyyy-MM-dd. This date is exclusive.

@UnitMultiplier

1

Will be equal to the number of days between EffectiveDate and ExpireDate. Multiply with the UnitMultiplier to get the total cost for the date span.

Rate / Base

0..1

Specifies the base per-day rate for the room. This is the gross amount charged for the room, not including any discounts or extra charges.

See TotalType

The total amount charged for the Rate. Will be equal to the Base amount with the extras and discounts applied. Note that the Total is gross, in other words the FULL amount charged for the per date rate as provided by the source channel.

NOTE: It is possible that some OTAs do not provide any form of Rate information and as such a RoomRate / Rate / Total cannot be provided in such cases. Currently Hotelbeds (HBD) is a known channel that does not always provide Rate information.

NOTE: Any extras that are to be included in the RoomRate total will be linked through the ServiceRPH node.

See TotalType

Contains links to any service or extra charges for the rate

@Type

Describes the additional information, please refer to the OTA Additional Detail Type (ADT) Code Table

Some common usages are 

43: Meal plan information
15: Promotion information

Guarantee / GuaranteesAccepted / GuaranteeAccepted / PaymentCard

0..1

Contains payment card information

@CardCode

0..1

The 2 character code of the credit card issuer. Please see the OTA Payment Card Provider Codes table for reference

The type of payment card, refer to the OTA Card Type code table for reference. Common usages are:

1: Credit
2: Debit

@CardNumber

0..1

The number embossed on the payment card

@ExpireDate

0..1

This is the expiry date of the payment card used in the format MMyy

Transaction results.

IMPORTANT NOTE: SCA / 3DS details will only be provided if received from an SCA / 3DS compatible booking agent. Information within the 'ThreeDomainSecurity' element will not be visible in The Channel Manager.

The type of payment information, this can be one of

PaymentGatewayName: The name of the payment gateway
PaymentGatewayAuthCode: The authorization code of the payment gateway
PaymentReferenceId: If a reference was provided for any payment, it will be included here

The comment Name will always be included if a Comment node is present here

ProfileInfo / UniqueID

0..n

Contains profile ids provided by the source channel. There can 0 to many identifiers passed through here

@Type

1

This will always be "16" to represent 'Reference' from the OTA code table Unique Id Type (UIT)

@ID

1

The reference identifier for the profile as provided by the source channel

@ID_Context

1

This can be one of 2 values:

CHANNEL: To specify that this is a channel reference id
IATA: To specify that this is an IATA identifier for a travel agent

ProfileInfo / Profile

1

Contains the profile information

@ProfileType

1

The type of profile See OTA Profile Type (PRT) code table. Some common usages are below

1: Customer
2: GDS
3: Corporation
4: TravelAgent
5: Wholesaler
21: Arranger 

Customer / Document

0..1

Detailed document information for the guest (e.g., driver license, passport, visa).

@DocID

1

Unique number assigned by authorities to document.

@DocType

1

Indicates the type of document (e.g. Passport, Military ID, Drivers License, national ID, Vaccination Certificate). Refer to the Document Type Code List

@Gender

0..1

Identifies the gender. Possible values are "Female", "Male", or "Unknown".

@BirthDate

0..1

Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format (YYYY-MM-DD).

@BirthCountry

0..1

Specifies the birth country of the document holder.

@BirthPlace

0..1

Specifies the birth place of the document holder (e.g., city, state, county, province), when designating a country of birth, use BirthCountry.

@DocHolderNationality

0..1

The country code of the nationality of the document holder.

@DocIssueAuthority

0..1

Indicates the group or association that granted the document.

@DocIssueCountry

0..1

Country where the document was issued.

@DocIssueLocation

0..1

Indicates the location where the document was issued.

@DocIssueStateProvince

0..1

State or Province where the document was issued.

@EffectiveDate

0..1

Indicates the starting date, in format YYYY-MM-DD.

@ExpireDate

0..1

Indicates the ending date, in format YYYY-MM-DD.

Document / DocumentHolderName

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 to be the name as per passport.

PersonName / GivenName

0..1

The name of the profile. Always present for type Customer.

PersonName / MiddleName

0..1

PersonName / Surname

0..1

The last name of the profile. Always present for type Customer.

Customer / Telephone

0..4

Contact telephone number for the profile if available

@PhoneNumber

0..1

The actual number, will be there if the Telephone element is there

@PhoneUseType

0..1

The type of phone use for example daytime, nighttime, work. If this field is blank this is the primary phone, otherwise PhoneUseType="4" denotes a secondary or nighttime phone

@PhoneTechType

The type of phone technology, if not provided it should be assumed as a landline

5: Mobile
3: Fax 

Customer / Email

0..1

The email address of the profile if available

Customer / Address

0..1

Address information for the profile if available

Address / AddressLine

0..n

One or more address lines for the profile 

Address / CityName

0..1

Customer city of residence if available

Address / PostalCode

0..1

Post code for profile if available

Address / StateProv

0..1

State or province name

Address / CountryName

0..1

Country name 

The account identification number for this particular member in this particular program.

The defined membership program name or ID applicable to program. This will be in the form as provided by the source booking channel.

The expiry date of the program membership issued to card holder. Date format is yyyy-MM-dd

@ServiceInventoryCode

1

The identifier code for the service as given by the source booking channel will be provided here. In the absence of a specific code being provided by the channel, the type of charge will be specified via one of the types specified in the Service and Extra Charge Reference Table.

@Quantity

0..1

The number of units included in the charge.

The amount per unit for this extra charge as provided by the hotel.

See BaseType (for details)

The unit tax amount for the BaseType

See TaxesType

The total tax amount for the TotalType

See TaxesType