The page will soon be discontinued. Please refer to this updated page instead - Click Here

1. GetAri V2 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

• Sandbox: https://sandbox-distribution-xml.agoda.com/api/v2/ari/search?apiKey=xxx

• Live: https://supply.agoda.com/api/v2/ari/search?apiKey=xxx

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

• Sandbox: https://sandbox-distribution-xml.agoda.com/api?apiKey=xxx

• Live: https://supply.agoda.com/api?apiKey=xxx

2. GetAri v2_RQ

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

<request timestamp="1559902413" type="11">

 <criteria from="2019-06-12" to="2019-06-12">

  <property id="5950804" room_id="76325369" rateplan_id="2380613"/>

  <property id="1949542" room_id="5478687"/>

 </criteria>

</request>

3. GetAri V2_Response

<result timestamp="1560330064047">

    <properties item_count="1">

        <property id="5950804" date="2019-06-12">

            <rates rateplan_id="2380613" currency="USD">

                <room room_id="76325369" closed="false" cta="false" ctd="false" min_los="3" max_los="5" min_staythrough="1">

                    <prices>

                        <occupancy person="5" price="500.00"/>

                        <occupancy person="1" price="100.00"/>

                        <occupancy person="2" price="200.00"/>

                        <occupancy person="3" price="300.00"/>

                        <occupancy person="4" price="400.00"/>

                    </prices>

                </room>

            </rates>

            <inventories>

                <room room_id="76325369" allotment="99" guaranteed_allotment="0" allotment_used_regular="0" allotment_used_guaranteed="0" closed="false" cta="false" ctd="false"/>

            </inventories>

        </property>

    </properties>

</result>

4. GetAri v2_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>