Get Rates & Availability

(Full Rate)

1. GetAri V1 EndPoint

agoda offers two types of endpoints:

Single endpoint : One Endpoint for all agoda calls,

Multiple endpoint : One Endpoint Per Call (each endpoint is configured unique to that call type).

NOTE: please note that if you wish to use the single endpoint for your request, the Type attribute will be mandatory in all the requests you will send to Agoda (this is to allow us to identify the call type).

GetAri - Multiple endpoint

GetAri - Single Endpoint (Please note: 'type=2' attribute is mandatory when using Single endpoint)

(replace xxx with your API Key)

2. GetAri v1_RQ

<?xml version="1.0" encoding="UTF-8"?>

</criteria>

</request>

3. GetAri V1_Response

</rates>

</rates>

</inventories>

</property>

</rates>

</rates>

</inventories>

</property>

</properties>

/result>

</rates>

</rates>

</inventories>

</property>

</properties>

/result>

4. GetAri v1_Schema

<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:simpleType name="requesttype">

<xs:restriction base="xs:string">

<xs:enumeration value="rate"/>

<xs:enumeration value="inventory"/>

<xs:enumeration value="both"/>

</xs:restriction>

</xs:simpleType>

<xs:simpleType name="endpointtype">

<xs:restriction base="xs:int">

<xs:enumeration value="2"/>

</xs:restriction>

</xs:simpleType>

<xs:simpleType name="idType">

<xs:restriction base="xs:unsignedLong">

<xs:maxInclusive value="2147483647"/>

</xs:restriction>

</xs:simpleType>

<xs:element name="request">

<xs:complexType>

<xs:sequence>

<xs:element name="criteria" maxOccurs="1" minOccurs="1">

<xs:complexType>

<xs:sequence>

<xs:element name="property" maxOccurs="unbounded" minOccurs="1">

<xs:complexType>

<xs:simpleContent>

<xs:extension base="xs:string">

<xs:attribute type="idType" name="id" use="required"/>

<xs:attribute type="idType" name="room_id" use="optional"/>

<xs:attribute type="idType" name="rateplan_id" use="optional"/>

<xs:attribute type="requesttype" name="type" use="optional"/>

</xs:extension>

</xs:simpleContent>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute type="xs:date" name="from" use="required"/>

<xs:attribute type="xs:date" name="to" use="required"/>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute type="xs:long" name="timestamp"/>

<xs:attribute type="endpointtype" name="type" />

</xs:complexType>

</xs:element>

</xs:schema>

4.1 GetAriV1 Schema Response

<?xml version="1.0" encoding="utf-8"?>

<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="result">

<xs:complexType>

<xs:sequence>

<xs:element name="errors" minOccurs="0" maxOccurs="1">

<xs:complexType>

<xs:sequence>

<xs:element name="error" minOccurs="1" maxOccurs="unbounded">

<xs:complexType>

<xs:simpleContent>

<xs:extension base="xs:string">

<xs:attribute type="xs:short" name="code"/>

<xs:attribute type="xs:string" name="description"/>

</xs:extension>

</xs:simpleContent>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="properties" minOccurs="0" maxOccurs="1">

<xs:complexType>

<xs:sequence>

<xs:element name="property" minOccurs="0" maxOccurs="unbounded">

<xs:complexType>

<xs:sequence>

<xs:element name="rates" minOccurs="0" maxOccurs="unbounded">

<xs:complexType>

<xs:sequence>

<xs:element name="room" minOccurs="0" maxOccurs="unbounded">

<xs:complexType>

<xs:sequence>

<xs:element name="prices">

<xs:complexType>

<xs:sequence>

<xs:element name="occupancy" minOccurs="0" maxOccurs="unbounded">

<xs:complexType>

<xs:attribute name="price" type="xs:decimal" use="required" />

<xs:attribute name="person" type="xs:unsignedByte" use="required" />

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="min_staythrough" type="xs:int" use="required" />

<xs:attribute name="max_los" type="xs:int" use="required" />

<xs:attribute name="min_los" type="xs:int" use="required" />

<xs:attribute name="ctd" type="xs:boolean" use="required" />

<xs:attribute name="cta" type="xs:boolean" use="required" />

<xs:attribute name="closed" type="xs:boolean" use="required" />

<xs:attribute name="extra_bed" type="xs:decimal" />

<xs:attribute name="room_id" type="xs:string" use="required" />

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="currency" type="xs:string" use="required" />

<xs:attribute name="rateplan_id" type="xs:string" use="required" />

</xs:complexType>

</xs:element>

<xs:element name="inventories">

<xs:complexType>

<xs:sequence>

<xs:element name="room">

<xs:complexType>

<xs:attribute name="ctd" type="xs:boolean" use="required" />

<xs:attribute name="cta" type="xs:boolean" use="required" />

<xs:attribute name="closed" type="xs:boolean" use="required" />

<xs:attribute name="allotment_used_guaranteed" type="xs:int" use="required" />

<xs:attribute name="allotment_used_regular" type="xs:int" use="required" />

<xs:attribute name="guaranteed_allotment" type="xs:int" use="required" />

<xs:attribute name="allotment" type="xs:int" use="required" />

<xs:attribute name="room_id" type="xs:string" use="required" />

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="date" type="xs:string" use="required" />

<xs:attribute name="date" type="xs:date" use="required" />

<xs:attribute name="id" type="xs:string" use="required" />

</xs:complexType>

</xs:element>

<xs:attribute name="timestamp" type="xs:unsignedLong" use="required" />

</xs:complexType>

</xs:element>

</xs:schema>

Get Rates & Availability

(Full Rate)

Contents

Click here to access detailed documentation.

1. GetAri V1 EndPoint

2. GetAri v1_RQ

3. GetAri V1_Response

4. GetAri v1_Schema

4.1 GetAriV1 Schema Response