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

1. GetBookingDetails 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).

GetBookingDetails - Multiple endpoint

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

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

 GetBookingDetails - Single endpoint (Please note: 'type=4' 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. GetBookingDetails RQ

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

<request timestamp="1436931804" type="3">

   <criteria language="JA">

     <property id="99">

         <booking id="10061388"/>

         <booking id="10009302"/>

         <booking id="10008589"/>

         <booking id="10008389"/>

    </property>

    </criteria>

 </request>

<!--

  Max property id is restricted to 1 (configurable)

  Max booking ids restricted to 50 (configurable)

-->

4. GetBookingDetails Schema

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

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

    <xs:simpleType name="endpointtype">

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

            <xs:enumeration value="4"/>

        </xs:restriction>

    </xs:simpleType>

    <xs:element name="request" type="requestType"/>

    <xs:complexType name="propertyType">

        <xs:sequence>

            <xs:element type="bookingType" name="booking" minOccurs="1" maxOccurs="unbounded"/>

        </xs:sequence>

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

    </xs:complexType>

    <xs:complexType name="requestType">

        <xs:sequence>

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

        </xs:sequence>

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

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

    </xs:complexType>

    <xs:complexType name="bookingType">

        <xs:simpleContent>

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

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

            </xs:extension>

        </xs:simpleContent>

    </xs:complexType>

    <xs:complexType name="criteriaType">

        <xs:sequence>

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

        </xs:sequence>

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

    </xs:complexType>

    <xs:simpleType name="languageType">

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

            <xs:length fixed="true" value="2"/>

            <xs:pattern value="[a-zA-Z]{2}"/>

        </xs:restriction>

    </xs:simpleType>

    <xs:simpleType name="idType">

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

            <xs:maxInclusive value="2147483647"/>

        </xs:restriction>

    </xs:simpleType>

</xs:schema>

5. GetBookingDetails Schema (from April 2023 onwards)

<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="bookings">

          <xs:complexType>

            <xs:sequence>

              <xs:element name="booking">

                <xs:complexType>

                  <xs:sequence>

                    <xs:element name="customer">

                      <xs:complexType>

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

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

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

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

                      </xs:complexType>

                    </xs:element>

                    <xs:element name="benefits">

                      <xs:complexType>

                        <xs:sequence>

                          <xs:element maxOccurs="unbounded" name="benefit">

                            <xs:complexType>

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

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

                            </xs:complexType>

                          </xs:element>

                        </xs:sequence>

                      </xs:complexType>

                    </xs:element>

                    <xs:element name="requests">

                      <xs:complexType>

                        <xs:sequence>

                          <xs:element maxOccurs="unbounded" name="request">

                            <xs:complexType>

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

                            </xs:complexType>

                          </xs:element>

                        </xs:sequence>

                      </xs:complexType>

                    </xs:element>

                    <xs:element name="payment">

                      <xs:complexType>

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

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

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

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

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

                        <!-- New UPC details -->

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

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

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

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

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

                      </xs:complexType>

                    </xs:element>

                    <xs:element name="prices">

                      <xs:complexType>

                        <xs:sequence>

                          <xs:element maxOccurs="unbounded" name="price">

                            <xs:complexType>

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

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

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

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

                            </xs:complexType>

                          </xs:element>

                        </xs:sequence>

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

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

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

                      </xs:complexType>

                    </xs:element>

                  </xs:sequence>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

                </xs:complexType>

              </xs:element>

            </xs:sequence>

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

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

          </xs:complexType>

        </xs:element>

      </xs:sequence>

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

    </xs:complexType>

  </xs:element>

</xs:schema>