API Reference

OTA_HotelResRQ

OTA_HotelResRQ Example

<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelResRQ TimeStamp="2013-08-28T13:40:00+01:00" Version="0.0" xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <POS>
        <Source>
            <RequestorID ID="96637800" ID_Context="IATA" Type="18" URL="AGODA.com"/>
        </Source>
    </POS>
    <HotelReservations>
        <HotelReservation CreateDateTime="2013-08-28T13:40:00+01:00">
            <RoomStays>
                <RoomStay>
                    <RoomRates>
                        <RoomRate NumberOfUnits="2" RoomTypeCode="3138110" RatePlanCode="25468" ChannelID="1">
                            <Features>
                                <Feature>
                                    <Description Name="ExtraBed">True</Description>
                                </Feature>
                            </Features>
                            <Rates>
                                <Rate UnitMultiplier="1" RateTimeUnit="Day" EffectiveDate="2013-09-28" ExpireDate="2013-09-29">
                                    <Base DecimalPlaces="2" CurrencyCode="SGD" AmountAfterTax="26836" AmountBeforeTax="26033" Tax="200" Fee="100" RefSell="27000"/>
                                </Rate>
                                <Rate UnitMultiplier="1" RateTimeUnit="Day" EffectiveDate="2013-09-29" ExpireDate="2013-09-30">
                                    <Base DecimalPlaces="2" CurrencyCode="SGD" AmountAfterTax="26836" AmountBeforeTax="26033" Tax="200" Fee="100" RefSell="27000"/>
                                </Rate>
                            </Rates>
                        </RoomRate>
                    </RoomRates>
                    <GuestCounts>
                        <GuestCount AgeQualifyingCode="10" Count="2"/>
                        <GuestCount AgeQualifyingCode="8" Count="1"/>
                    </GuestCounts>
                    <Total DecimalPlaces="2" CurrencyCode="SGD" AmountAfterTax="53672" AmountBeforeTax="52066" Tax="400" Fee="200" RefSell="54000"/> 
                </RoomStay>
            </RoomStays>
            <ResGuests>
                <ResGuest ResGuestRPH="1" PrimaryIndicator="True">
                    <Profiles>
                        <ProfileInfo>
                            <Profile>
                                <Customer>
                                    <PersonName>
                                        <GivenName>John</GivenName>
                                        <Surname>Doe</Surname>
                                    </PersonName>
<Telephone>1234567890</Telephone>
<Email>[email protected]</Email>
                                    <CitizenCountryName>TH</CitizenCountryName>
                                </Customer>
                            </Profile>
                        </ProfileInfo>
                    </Profiles>
                </ResGuest>
            </ResGuests>
            <ResGlobalInfo>
                <TimeSpan Start="2013-09-28" End="2013-09-30"/>
                <SpecialRequests>
                    <SpecialRequest>
                        <Text>NonSmoke, HighFloor</Text>
                    </SpecialRequest>
                </SpecialRequests>
                <Guarantee>
                    <GuaranteesAccepted>
                        <GuaranteeAccepted>
                            <PaymentCard>
                                <CardHolderName>Agoda Company Pte Ltd.</CardHolderName>
                                <CardNumber ExpireDate="03/2017" SecureInd="170">503444796022xxxx</CardNumber>
                            </PaymentCard>
                        </GuaranteeAccepted>
                    </GuaranteesAccepted>
                </Guarantee>
                <HotelReservationIDs>
                    <HotelReservationID ResID_Value="1234" ResID_Type="4" ResID_Source="Agoda"/>
                </HotelReservationIDs>
                <BasicPropertyInfo HotelCode="6000089"/>
            </ResGlobalInfo>
            <TPA_Extensions>Generic Data Tag</TPA_Extensions>
        </HotelReservation>
    </HotelReservations>
</OTA_HotelResRQ>

Elements and Attributes

OTA_HotelResRQ
Element or @AttributeData TypeNo. of occurMandatoryExampleDescription
OTA_HotelResRQDatetime1Y2016-09-01T13 :25 :42+07:00Indicates the creation date and time of the message using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ss(+/-)hh:mm with time values using the 24 hour clock (e.g. 20 November 2016, 1:59:38 pm BKK becomes 2016-11-20T13:59:38+07:00).
@Timestamp
@VersionDouble1Y0.1For all OTA versioned messages, the version of the message is indicated by a double value (format n.n).
@xmlnsString1Yhttp://www.opentravel.org/OTA/2003/05Namespace for the OTA payload message.
@xmlns :xsiString1Yhttp://www.w3.org/2001/XMLSchema-instanceNamespace for XML schema-instance.
POSNumeric length 81Y96637800Unique identifier of the requestor.
SourceAgoda’s IATA ID is 96637800
RequestorID
@ID
@ID_ContextString length 41YIATAUsed to identify the source of the identifier
@TypeOTA_CodeType1Y18Reference to the type of requestor. 18 = Other
Refer to Appendix E for more details
@URLString length 1 to 501YAgoda.comUsed to identify the source URL
HotelReservationsDatetime1Y2016-09-01T00:00:00+07:00Indicates the booking date and time using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ss(+/-)hh:mm with time values using the 24 hour clock (e.g. 20 November 2016, 1:59:38 pm BKK becomes 2016-11-20T13:59:38+07:00).
HotelReservation
@CreateDateTime
RoomRatesnumeric1Y2Details on the room rates associated with the reservation.
RoomRateUsed to identify the number of room to be booked.
@NumberOfUnits
@RoomTypeCodestring length1Y3138110Used to identify the unique room type code to be booked.
1 to 20
@RatePlanCodestring length1Y25468Used to identify the unique rate plan code to be booked.
1 to 20
@ChannelIDnumeric[0..1]N1Used to identify the channel id to be booked. This field will be provided for YCS5 hotel only.
**Supplier should have the channel id mapping for channel id and channel name if it required in supplier side.
Refer to Appendix F for more details
FeaturesString length 1 to 250[0..n]NExtraBedTo identify feature of that room for example, ExtraBed etc.
Feature
Description
@Name
Ratesnumeric[1..n]Y1The number of days between effective date and expiry date with that particular rate
Rate
@UnitMultiplier
@RateTimeUnitString length 1 to 201YDayDefault for Agoda Request it will be “Day”
@EffectiveDatedate1Y4/2/2016Effective date for that particular date the format will be “YYYY-MM-DD”
@ExpireDateDate1Y4/3/2016Expire date for that particular date the format will be “YYYY-MM-DD”
Ratesnumeric[1..n]Y2Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard “minor unit”. Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=”2” to represent $85
Rate
Base
@DecimalPlaces
@CurrencyCodeAlpha1YUSDThe code specifying a monetary unit. Use ISO 4217, three alpha code.
length 3
@AmountAfterTaxdouble[0..1]N26836Daily room price include tax multiplied by number of rooms.
To calculate this number, it may need to refer to Decimal place value which define for the floating point for this number for example
Price = 26836 and DecimalPlaces = 2 so the value will be $268.36
Price can be Net or Sell price depend on property setting.
@ AmountBeforeTaxdouble[0..1]N26033Daily room price exclude tax multiplied by number of rooms.
To calculate this number, it may need to refer to Decimal place value which define for the floating point for this number for example
Price = 26033 and DecimalPlaces = 2 so the value will be $260.33
Price can be Net or Sell price depend on property setting.
@ Taxdouble[0..1]N200Daily Tax multiplied by number of rooms.
To calculate this number, it may need to refer to Decimal place value which define for the floating point for this number for example
Price = 26033 and DecimalPlaces = 2 so the value will be $260.33
@ Feedouble[0..1]N100Daily Fee multiplied by number of rooms.
To calculate this number, it may need to refer to Decimal place value which define for the floating point for this number for example
Price = 26033 and DecimalPlaces = 2 so the value will be $260.33
@ RefSelldouble[0..1]N27000Daily Reference sell (Sell Inclusive) multiplied by number of rooms.
To calculate this number, it may need to refer to Decimal place value which define for the floating point for this number for example
Price = 26033 and DecimalPlaces = 2 so the value will be $260.33
GuestCounts[1..n]YDetail of number of guests.
GuestCount
@AgeQualifyingCodeNumeric1Y10A code representing a business rule that determines the charges for a guest based upon age range (e.g. Adult, Child, Senior, Child With Adult, Child Without Adult). Refer to OpenTravel Code List Age Qualifying Code (AQC)
@CountNumeric1N1The number of that particular specific guest type.
Totalnumeric[1..n]Y2Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard “minor unit”. Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=”2” to represent $85
@ DecimalPlaces
@CurrencyCodeAlpha1YUSDThe code specifying a monetary unit. Use ISO 4217, three alpha code.
length 3
@AmountAfterTaxdouble[0..1]N26836Total room price include tax multiplied by number of rooms and nights.
To calculate this number, it may need to refer to Decimal place value which define for the floating point for this number for example
Price = 26836 and DecimalPlaces = 2 so the value will be $268.36
Price can be Net or Sell price depend on property setting.
@ AmountBeforeTaxdouble[0..1]N26033Total room price exclude tax multiplied by number of rooms and nights.
To calculate this number, it may need to refer to Decimal place value which define for the floating point for this number for example
Price = 26033 and DecimalPlaces = 2 so the value will be $260.33
Price can be Net or Sell price depend on property setting.
@ Taxdouble[0..1]N200Total Tax multiplied by number of rooms and nights.
To calculate this number, it may need to refer to Decimal place value which define for the floating point for this number for example
Price = 26033 and DecimalPlaces = 2 so the value will be $260.33
@ Feedouble[0..1]N100Total Fee multiplied by number of rooms and nights.
To calculate this number, it may need to refer to Decimal place value which define for the floating point for this number for example
Price = 26033 and DecimalPlaces = 2 so the value will be $260.33
@ RefSelldouble[0..1]N27000Total Reference sell (Sell Inclusive) multiplied by number of rooms and nights.
To calculate this number, it may need to refer to Decimal place value which define for the floating point for this number for example
Price = 26033 and DecimalPlaces = 2 so the value will be $260.33
ResGuests1YDetail of guests associated with a reservation.
ResGuest[1..n]YDetail of each guest associated with reservation. Agoda can send only lead guest information or all guests to be stayed at the hotel.
@ResGuestRPHNumeric1Y1The index of guest.
@PrimaryIndicatorBoolean1YTrue/FalseTo identify the guest is primary contact.
Profiles1YIdentify guest profile
ProfileInfo
Profile
Customer
PersonName
GivenName1YGiven name, first name or names
Surname1YFamily name, last name
Telephone[0..1]Y1234567890Customer phone number. This can be alphanumeric.
Email[0..1]N[email protected]Email address of the customer.
CitizenCountryName[0..1]NTHCitizen Country name (e.g. TH, CN, JP, US)
Refer to Appendix A : Guest Country
ResGlobalInfo1YResGlobalInfo is a container for various information that affects the Reservation as a whole. These include global comments, counts, reservation IDs, loyalty programs, and payment methods
TimeSpan1YThe Time Span which covers the period of stay.
@Startdatetime1Y8/22/2016Check-in date with format YYYY-MM-DD
@Enddatetime1Y8/25/2016Check-out date with format YYYY-MM-DD
SpecialRequests[0..1]NIdentify customer’s additional requests.
SpecialRequest
Textstring length1YNonSmoke, HighFloor, AdditionalNotes:Swimming Pool View  Connecting rooms or adjoining rooms please.,The string of special request list separate each request by ‘,’.
1 to 250
Refer to Appendix B: Agoda Special Request
Guarantee[0..1]NDetail of payment information
GuaranteesAccepted
GuaranteeAccepted
PaymentCard1YDetail of credit card
CardHolderNameAlpha1YAgoda Company Pte Ltd.Name on credit card. For all bookings will show ‘Agoda Pte Ltd.’
CardNumbernumeric1Y503444796022xxxxNumber of the Agoda UPC (Unique Plastic Card) used by the property to debit the amount of the booking.
length 16
@ExpiredDate1Y17-MarCredit card expiry date in format MM/YY
@SecureIndnumeric1Y170Credit card CVV number
length
3
HotelReservationIDs1YDetail of hotel reservation contains various unique (ReservationID) and non-unique (ConfirmationID, CancellationID) identifiers that the trading partners associate with a given reservation
HotelReservationID
@ResID_Valuestring1Y76104819Agoda’s booking ID
length
1 to 20
@ResID_TypeNumeric1Y4Reference to the type of requestor. 4 = Agoda booking ID
@ResID_Sourcestring1YAgodaSource of booking, It’s always Agoda.
length
1 to 20
BasicPropertyInfo1YProperty Information for the Room Stay
@ HotelCodestring1Y6000089Used to identify the unique hotel id to be booked.
length
1 to 20
TPA_Extensionsstring length[0..1]NAn element for additional data if needed.
1 to 250