Request URL: https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE
This function allows the Connectivity Partners to collect the booking details for a specific property up to 50 bookings at once. The data retention period for booking details is 90 days.
Example Request
curl --location 'https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE' \
--header 'Content-Type: application/xml' \
--data '<?xml version="1.0" encoding="UTF-8"?>
<request timestamp="1436931804" type="4">
<criteria language="EN">
<property id="99">
<booking id="10061388"/>
<booking id="10009302"/>
<booking id="10008589"/>
<booking id="10008390"/>
<booking id="10061395"/>
</property>
</criteria>
</request>
<!--
Max property id is restricted to 1
Max booking ids restricted to 50
-->'
Example Response
<result timestamp="1501647925927">
<bookings count="1" iataid="96637800">
<booking property_id="567792" property_name="PCLN Hotel Test - Do Not Book" booking_id="220952733" booking_date="2017-08-02T11:24:00+07:00" last_action="2017-08-02T11:24:14+07:00" arrival="2017-08-16" departure="2017-08-17" status="ConfirmBooking" acknowledge="0" room_id="8179856" room_type="Standard - 2 persons" channel_id="1" channel_name="Retail" rateplan_id="937982" rateplan_name="Room Only111" promotion_id="141776369" promotion_name="Limited time offer. Rate includes 20% discount!" room_count="1" adults="2" children="0" extrabeds="0" cxl_code="1D1N_1N">
<customer first_name="agoda" last_name="test" nationality="Thailand"/>
<requests>
<request request_name="NonSmoke"/>
<request request_name="AdditionalNotes:"**Late arrival 23:00**""/>
</requests>
<prices currency="USD" sell_inclusive_amt="269.28">
<price date="2017-08-16" sell_inclusive_amt="269.28" type="Room"/>
</prices>
<paymentmodel>2</paymentmodel>
</booking>
</bookings>
</result>
<result timestamp="1501649348742">
<bookings count="1" iataid="96637800">
<booking property_id="567792" property_name="PCLN Hotel Test - Do Not Book" booking_id="220952733" booking_date="2017-08-02T11:24:00+07:00" last_action="2017-08-02T11:48:49+07:00" arrival="2017-08-16" departure="2017-08-17" status="CancelBooking" acknowledge="0" room_id="8179856" room_type="Standard - 2 persons" channel_id="1" channel_name="Retail" rateplan_id="937982" rateplan_name="Room Only111" promotion_id="141776369" promotion_name="Limited time offer. Rate includes 20% discount!" room_count="1" adults="2" children="0" extrabeds="0" cxl_code="1D1N_1N">
<customer first_name="agoda" last_name="test" nationality="Thailand"/>
<requests>
<request request_name="NonSmoke"/>
<request request_name="AdditionalNotes:"**Late arrival 23:00**""/>
</requests>
<prices currency="USD" sell_inclusive_amt="0.0">
<price date="" sell_inclusive_amt="0.0" refsell_amt="0.0" type="Cancellation"/>
</prices>
<paymentmodel>2</paymentmodel>
</booking>
</bookings>
</result>
Booking Details - Pricing Structures
Agoda has different configurations to return different pricing structures in GetBookingDetails, which are based on property location and payment model. Including:
- Default (Agoda Collect): net_inclusive and ref_sell
- Property Collect: Sell_inclusive
- Taiwan: Net_inclusive
- US and its territories*: Net_exclusive, Net_inclusive, Tax and fee
*US and its territories include: USA, Puerto Rico, US Virgin Islands, Marshall Islands, American Samoa, Guam, Palau, Northern Mariana Islands, Federated States of Micronesia
Best Practice:
When retrieving booking details, channel manager should be able to handle all property payment types (UPC, UPC on Epass, E-card, and Telex Transfer).
Please note that VCC details are only provided for UPC bookings. For other payment types, VCC information will not be included. In this case, please do not set the presence of VCC details as a mandatory requirement in the booking details response. This is to avoid errors when retrieving bookings from non-UPC properties and will help ensure booking retrieval works smoothly across all properties.