API Reference

OTA_HotelAvailRQ

You can search single or multiple properties for detailed availability and pricing information of room products by using the OTA_HotelAvailRQ request. Agoda will respond to your request via OTA_HotelAvailRS response message. OTA_HotelAvailRQ
The following search type is supported by the HotelAvail Request message.
Searching availability for single property - return the availability for a single property by a unique hotel id for a specified date range.

Example

<OTA_HotelAvailRQ PrimaryLangID="en" xmlns="http://www.opentravel.org/OTA/2003/05">
    <AvailRequestSegments>
        <AvailRequestSegment>
            <StayDateRange Start="2017-11-25" End="2017-11-29"/>
            <RatePlanCandidates>
                <RatePlanCandidate RatePlanCode="RAC"/>
            </RatePlanCandidates>
            <RoomStayCandidates>
                <RoomStayCandidate RoomTypeCode="A1K" Quantity="1">
                    <GuestCounts>
                        <GuestCount AgeQualifyingCode="10" Count="2"/>
                    </GuestCounts>
                </RoomStayCandidate>
            </RoomStayCandidates>
            <HotelSearchCriteria>
                <Criterion>
                    <HotelRef HotelCode="61027"/>
                </Criterion>
            </HotelSearchCriteria>
        </AvailRequestSegment>
    </AvailRequestSegments>
</OTA_HotelAvailRQ>

Elements and Attributes

Element

Number

Type

Description





OTA_HotelAvailRQ

1


Root node








Primary language preference for the message.

@PrimaryLangID

0..1

String

Identified by ISO 639 codes.





OTA_HotelAvailRQ/




AvailRequestSegments








AvailRequestSegments/




AvailRequestSegment








AvailRequestSegment/




StayDateRange








@Start

1

Date

The starting value of the time span





@End

1

Date

The ending value of the time span





AvailRequestSegment/




RatePlanCandidates








RatePlanCandidates/




RatePlanCandidate








@RatePlanCode

1

String

Identifies the rate plan code





AvailRequestSegment/




RoomStayCandidates








RoomStayCandidates/




RoomStayCandidate











Indicates the number of rooms to book. If this

@Quantity

1

Integer

attribute is not sent or is not valid, validation error




is returned.





@RoomTypeCode

1

String

Identifies the room type code.





RoomStayCandidate/




GuestCounts








GuestCounts/




GuestCount








@AgeQualifyingCode

1

Integer

This value is always “10”





@Count

1

Integer

The number of guests in one AgeQualifyingCode

AvailRequestSegment/




HotelSearchCriteria








HotelSearchCriteria/




Criteria








Criteria/




Criterion








Criterion/




HotelRef








@HotelCode

1StringThe code that uniquely identifies a single hotel property