Booking Retrieval
GetBookingList - Selected Properties
GetBookingList V2 - All Properties
GetBookingDetail - Booking Retrieval
GetBookingDetail - Japanese Properties
Element and Attributes (Data Type)
Get BookingList Request
Get BookingList Response
Get BookingListV2 Request
Get BookingListV2 Response
Get BookingDetails Request
Get BookingDetails Response
GetBookingList - Selected Properties
Request URL: https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE
Example Request
curl --location 'https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE' \
--header 'Content-Type: text/xml' \
--data '<?xml version="1.0" encoding="UTF-8"?>
<request type="3" timestamp="1436931804">
<!-- Property = 5 LookBack = 90 Days Now - From <= 90 Days -->
<!-- from & to is specified with an offset from the UTC time by adding a positive or negative time behind the time - like this: -->
<criteria status="AmendBooking" to="2020-04-30T00:00:00+07:00" from="2020-04-01T00:00:00+07:00">
<property id="10730279"/>
</criteria>
</request>'Example Response
<result timestamp="1587628325674">
<properties count="1">
<property id="10730279">
<bookings>
<booking booking_id="473966145" booking_date="2020-04-23T14:32:00+07:00" last_action="2020-04-23T14:51:45+07:00" arrival="2020-04-24" departure="2020-04-25" status="AmendBooking" acknowledge="0"/>
</bookings>
</property>
</properties>
</result>Time interval criteria example
| Request Time | From Date | To date |
|---|---|---|
| 2018-07-17 18:00:00 (GMT+7) | 2018-07-17 at 17:55:00 (GMT+7) | 2018-07-17 at 18:00:00 (GMT+7) |
| 2018-07-17 18:05:00 (GMT+7) | 2018-07-17 at 18:00:00 (GMT+7) | 2018-07-17 at 18:05:00 (GMT+7) |
| 2018-07-17 18:10:00 (GMT+7) | 2018-07-17 at 18:05:00 (GMT+7) | 2018-07-17 at 18:10:00 (GMT+7) |
GetBookingList V2 - All Properties
Request URL: https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE
Example Request
curl --location 'https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE' \
--header 'Content-Type: text/xml' \
--data '<?xml version="1.0" encoding="UTF-8"?>
<request type="9" timestamp="1436931804">
<!-- Property = 5 LookBack = 90 Days Now - From <= 90 Days -->
<!-- from & to is specified with an offset from the UTC time by adding a positive or negative time behind the time - like this: -->
<criteria status="AmendBooking" from="2020-04-23T14:00:00+07:00" to="2020-04-23T15:00:00+07:00">
<property id="10730279"/>
</criteria>
</request>'Example Response
<result timestamp="1587628325674">
<properties count="1">
<property id="10730279">
<bookings>
<booking booking_id="473966145" booking_date="2020-04-23T14:32:00+07:00" last_action="2020-04-23T14:51:45+07:00" arrival="2020-04-24" departure="2020-04-25" status="AmendBooking" acknowledge="0"/>
</bookings>
</property>
</properties>
</result>Time interval criteria example
| Request Time | From Date | To date |
|---|---|---|
| 2018-07-17 18:00:00 (GMT+7) | 2018-07-17 at 17:55:00 (GMT+7) | 2018-07-17 at 18:00:00 (GMT+7) |
| 2018-07-17 18:05:00 (GMT+7) | 2018-07-17 at 18:00:00 (GMT+7) | 2018-07-17 at 18:05:00 (GMT+7) |
| 2018-07-17 18:10:00 (GMT+7) | 2018-07-17 at 18:05:00 (GMT+7) | 2018-07-17 at 18:10:00 (GMT+7) |
GetBookingDetail - Booking Retrieval
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.
GetBookingDetail - Japanese Properties
Request URL: https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE
The customized Japan Child Rates feature will be deployed only on properties located within Japan. The Japan Child Rates has to be set manually on the YCS Extranet, and can be retrieved via the GetBookingDetails endpoint. The booking retrieval response for Japanese properties will be identical with the standard response, with the additional "occupancy" element, which provides a headcount for adults and children within each age bucket.
Example Request
<?xml version="1.0" encoding="UTF-8"?>
<request timestamp="1436931804">
<criteria language="JA">
<property id ="20389XXXX">
<booking id="6407XXXX"/>
</property>
</criteria>
</request>
<!--
Max property id is restricted to 1 (configurable)
Max booking ids restricted to 50 (configurable)
-->Example Response
<result timestamp="1653637167151">
<bookings count="1" iataid="96637800">
<booking property_id="203895644" property_name="J-ASO hotel" booking_id="64071569" booking_date="2022-05-27T14:37:00+07:00" last_action="2022-05-27T14:36:42+07:00" arrival="2022-06-13" departure="2022-06-14" status="ConfirmBooking" acknowledge="0" room_id="1207710824" room_type="スタジオ" channel_id="1" channel_name="Retail" rateplan_id="8155680" rateplan_name="Japan ASO no imageee" promotion_id="75052985" promotion_name="Limited Time Offer. Price includes 25% discount!" room_count="1" adults="2" children="0" extrabeds="0" cxl_code="126D100P_100P">
....
<prices currency="JPY" net_inclusive_amt="9948.0" refsell_amt="11250.0">
<price date="2022-06-13" net_inclusive_amt="9948.0" refsell_amt="11250.0" type="Room"/>
<price date="2022-06-14" net_inclusive_amt="9948.0" refsell_amt="11250.0" type="Room"/>
</prices>
<occupancy>
<adult count="1"/>
<child type="A: 食事及び寝具" count="1"/>
<child type="B: 子供用食事及び寝具" count="1"/>
<child type="C: 寝具のみ" count="1"/>
<child type="D: 食事寝具共になし" count="1"/>
</occupancy>
</booking>
</bookings>
</result>| Element | Attribute | Datatype | Description |
|---|---|---|---|
| occupancy | Breakdown of occupancy per each booking | ||
| adult | count | numeric | Indicates the number of adults in the booking ID |
| child | type | string | Child type for Japanese properties. There are 4 types, defined as follows: A: Standard beddings and reduced portion of standard adult meal B: Standard beddings and special children’s meal C: Beddings only (no meals) D: No beddings or meals included |
| child | count | numeric | Indicates the number of children for each child type in the booking ID |
For more information, please see the details on GetBookingDetailsRQ elements and attributes section below.
Element and Attributes (Data Type)
Get BookingList Request
| Element / Attribute | Data Type | Occurs | Required | Examples | Description |
|---|---|---|---|---|---|
| Request Timestamp | Numeric | 1 | Y | 1483526410357 (GMT: Wed, 04 Jan 2017 10:40:10.357) | A timestamp is a sequence of characters or encoded information identifying when a certain event occurred. Time provided must correspond with the time in the originating system and in EPOCH. System requires EPOCH timestamps in milliseconds. |
| Type | Numeric Length 1 | 1 | Y | 3 | This number identifies a particular request: 1 SetAri 2 GetAri 3 GetBookingList 4 GetBookingDetail 5 GetProduct 8 SetProduct 9 GetBookingListV2 |
| Criteria from to | Datetime YYYY-MM-DD HH:MM:SS | 1 | Y | 2015-09-01T00:00:00+07:00 | The inclusive start (from) and end (to) date and time for the booking query. The inclusive start (from) and end (to) date and time for the booking query. Time of reference is always UTC time zone +/- to identify other timezones. From date time cannot be older than 740 days. Date range allows up to 90 days per request. |
| status | Alpha | 1 | N | AmendBooking | Denotes the type of bookings to query. Options are: ConfirmBooking AmendBooking CancelBooking |
| Property Id | String Length 1-20 | 1 | Y | 12345678910 | Every request must contain a valid property ID that partner has access to. Every property has a unique ID in Agoda and every Channel Manager partner has to have the access to this specific property via an authorized API key. Maximum 5 property IDs can be queried in this GetBookingList request. |
Get BookingList Response
| Element / Attribute | Data Type | Occurs | Required | Examples | Description |
|---|---|---|---|---|---|
| Result Timestamp | Numeric | 1 | Y | 1454628391 (2016-02-04T23:26:31Z) | A timestamp is a sequence of characters or encoded information identifying when a certain event occurred. Time provided will correspond with the time in the originating system and in EPOCH. System requires EPOCH timestamps in milliseconds. |
| Properties count | Numeric 1-5 | 1 | Y | 1 | Count indicates number of properties. In this request a maximum of 5 properties can be requested to retrieve the bookings. |
| Property Id | String Length 1-20 | 1 | Y | 12345678910 | Every request must contain a valid property ID that partner has access to |
| Booking booking_id | Numeric Length 1-20 | 1 | Y | 4335173 | Agoda Booking ID for this booking. This must be used when sending GetBookingDetails request |
| booking_date | Datetime YYYY-MM-DD HH:MM:SS | 1 | Y | 2015-09-15T12:39:00+07:00 | Date that booking was created on Agoda YCS5. Time of reference is always UTC time zone +/- to identify other timezones. |
| last_action | Datetime YYYY-MM-DD HH:MM:SS | 1 | Y | 2015-09-15T12:47:33+07:00 | The last date that the booking was actioned: created/amended/cancelled. If booking is amended multiple times only the last amended date is listed here. Time of reference is always UTC time zone +/- to identify other timezones. |
| arrival | Date YYYY-MM-DD | 1 | Y | 10-4-2015 | The inclusive start date for the booking (check in date) |
| departure | Date YYYY-MM-DD | 1 | Y | 10-5-2015 | The inclusive end date for the booking (check out date) |
| status | Alpha | 1 | Y | ConfirmBooking | Denotes the status type of bookings. Statuses are: ConfirmBooking AmendBooking CancelBooking |
| acknowledge | 0 - 1 | 1 | Y | 0 | It defines if a booking is already acknowledged or not: 0= not acknowledge 1= acknowledged |
Get BookingListV2 Request
| Element / Attribute | Data Type | Occurs | Required | Examples | Description |
|---|---|---|---|---|---|
| Request Timestamp | Numeric | 1 | Y | 1483526410357 (GMT: Wed, 04 Jan 2017 10:40:10.357) | A timestamp is a sequence of characters or encoded information identifying when a certain event occurred. Time the XML was generated in the originating system in EPOCH. System requires EPOCH timestamps in milliseconds. |
| Type | Numeric Length 1 | 1 | Y | 9 | This number identifies a particular request: 1 SetAri 2 GetAri 3 GetBookingList 4 GetBookingDetail 5 GetProduct 8 SetProduct 9 GetBookingListV2 |
| Criteria from to | Datetime YYYY-MM-DD HH:MM:SS | 1 | Y | 2015-09-01T00:00:00+07:00 | The inclusive start (from) and end (to) date and time for the booking query based on last action. The inclusive start (from) and end (to) date and time for the booking query. Time of reference is always UTC time zone +/- to identify other timezones. From date time cannot be older than 740 days. Date range allows up to 60 mins per request. |
| status | Alpha | 1 | N | AmendBooking | Denotes the type of bookings to query. Options are: ConfirmBooking AmendBooking CancelBooking If no status specified, all booking status will be returned. |
| Result Timestamp | Numeric | 1 | 1483526410357 (2017-01-04 10:40:10.357) | 2015-09-15T12:39:00+07:00 | A timestamp is a sequence of characters or encoded information identifying when a certain event occurred. Time the XML was generated in the originating system in EPOCH. System requires EPOCH timestamps in milliseconds. |
| Properties count | Numeric 1-5 | 1 | Y | 1 | Count indicates number of properties. |
| Property Id | String Length 1-20 | 1 | Y | 123 | Every request must contain a valid property ID that partner has access to and correspond with booking ID |
| Booking booking_id | String Length 1-20 | 1 | Y | 10-5-2015 | Agoda Booking ID for this booking. This must be used when sending GetBookingDetails request |
| booking_date | Alpha | 1 | Y | ConfirmBooking | Date that booking was created on Agoda YCS5. Time of reference is always UTC time zone +/- to identify other timezones. |
| last_action | 0 - 1 | 1 | Y | 0 | It defines if a booking is already acknowledged or not: 0= not acknowledge 1= acknowledged |
| arrival | Date YYYY-MM-DD | 1 | 2016-10-05 | The inclusive start date for the booking (check in date) | |
| departure | Date YYYY-MM-DD | 1 | 2016-10-05 | The inclusive end date for the booking (check out date) | |
| status | Alpha | 1 | ConfirmBooking | Denotes the status type of bookings. Statuses are: ConfirmBooking AmendBooking CancelBooking | |
| acknowledge | 0 - 1 | 1 | 0 | It defines if a booking is already acknowledged or not: 0= not acknowledge 1= acknowledged |
Get BookingListV2 Response
| Element / Attribute | Data Type | Occurs | Required | Examples | Description |
|---|---|---|---|---|---|
| Result Timestamp | Numeric | 1 | Y | 1454628391 (2016-02-04T23:26:31Z) | A timestamp is a sequence of characters or encoded information identifying when a certain event occurred. Time the XML was generated in the originating system in EPOCH. System requires EPOCH timestamps in milliseconds. |
| Properties count | Numeric 1-5 | 1 | Y | 1 | Count indicates number of properties. In this request a maximum of 5 properties can be requested to retrieve the bookings. |
| Property Id | String Length 1-20 | 1 | Y | 12345678910 | Every request must contain a valid property ID that partner has access to |
| Booking booking_id | Numeric Length 1-20 | 1 | Y | 4335173 | Agoda Booking ID for this booking. This must be used when sending GetBookingDetails request |
| booking_date | Datetime YYYY-MM-DD HH:MM:SS | 1 | Y | 2015-09-15T12:39:00+07:00 | Date that booking was created on Agoda YCS5. Time of reference is always UTC time zone +/- to identify other timezones. |
| last_action | Datetime YYYY-MM-DD HH:MM:SS | 1 | Y | 2015-09-15T12:47:33+07:00 | The last date that the booking was actioned: created/amended/cancelled. If booking is amended multiple times only the last amended date is listed here. Time of reference is always UTC time zone +/- to identify other timezones. |
| arrival | Date YYYY-MM-DD | 1 | Y | 10-4-2015 | The inclusive start date for the booking (check in date) |
| departure | Date YYYY-MM-DD | 1 | Y | 10-5-2015 | The inclusive end date for the booking (check out date) |
| status | Alpha | 1 | Y | ConfirmBooking | Denotes the status type of bookings. Statuses are: ConfirmBooking AmendBooking CancelBooking |
| acknowledge | 0 - 1 | 1 | Y | 0 | It defines if a booking is already acknowledged or not: 0= not acknowledge 1= acknowledged |
Get BookingDetails Request
| Element / Attribute | Data Type | Occurs | Required | Examples | Description |
|---|---|---|---|---|---|
| Request Timestamp | Numeric | 1 | Y | 1483526410357 (GMT: Wed, 04 Jan 2017 10:40:10.357) | A timestamp is a sequence of characters or encoded information identifying when a certain event occurred. Time the XML was generated in the originating system in EPOCH. System requires EPOCH timestamps in milliseconds. |
| Type | Numeric Length 1 | 1 | Y | 3 | This number identifies a particular request: 1 SetAri 2 GetAri 3 GetBookingList 4 GetBookingDetail 5 GetProduct 8 SetProduct 9 GetBookingListV2 |
| Criteria Language | Alpha Lentgh 2 | 1 | Y | EN | Language in which the response will be returned. If the language is not correct, the response will return a warning and the response in English. Refer to language list for languages available for use. |
| Property Id | String Length 1-20 | 1 | N | 12345678910 | Every request must contain a valid property ID that partner has access to. Every property has a unique ID in Agoda and every Channel Manager partner has to have the access to this specific property via an authorized API key. |
| booking_id | Numeric Length 1-20 | 11 to 50 | Y | 4335173 | Agoda Booking ID for this booking. This ID is required when sending GetBookingDetails request and maximum number of booking id that can be set in this request is 50. |
Get BookingDetails Response
| Element / Attribute | Data Type | Occurs | Required | Examples | Description |
|---|---|---|---|---|---|
| Result Timestamp | Numeric | 1 | Y | 1454628391 (2016-02-04T23:26:31Z) | A timestamp is a sequence of characters or encoded information identifying when a certain event occurred. Time the XML was generated in the originating system in EPOCH. System requires EPOCH timestamps in milliseconds. |
| Bookings count | Numeric 1-50 | 1 | Y | 1 | Count indicates number of bookings returned for the requested property. |
| iataid | Numeric | 1 | Y | 96637800 | Lists Agoda IATA number. |
| Property Id | String Length 1-20 | unbounded | N | 12345678910 | Agoda property ID. If booking ID is not returned, invalid Booking ID was not found against property ID in Request. |
| property_name | Alpha | 1 | Y | Sunshine Garden Resort | Agoda Booking ID for this booking. This must be used when sending GetBookingDetails request |
| booking_id | Numeric Length 1-20 | 1 | Y | 4335173 | |
| booking_date | Datetime YYYY-MM-DD HH:MM:SS | 1 | Y | 2015-09-15T12:39:00+07:00 | Date that booking was created on Agoda YCS5. Time of reference is always UTC time zone +/- to identify other timezones. |
| last_action | Datetime YYYY-MM-DD HH:MM:SS | 1 | Y | 2015-09-15T12:47:33+07:00 | The last date that the booking was actioned: created/amended/cancelled. If booking is amended multiple times only the last amended date is listed here. Time of reference is always UTC time zone +/- to identify other timezones. |
| arrival | Date YYYY-MM-DD | 1 | Y | 10-4-2015 | The inclusive start date for the booking (check in date) |
| departure | Date YYYY-MM-DD | 1 | Y | 10-5-2015 | The inclusive end date for the booking (check out date) |
| status | Alpha | 1 | Y | ConfirmBooking | Denotes the status type of bookings. Statuses are: ConfirmBooking AmendBooking CancelBooking |
| acknowledge | 0 - 1 | 1 | Y | 0 | It defines if a booking is already acknowledged or not: 0= not acknowledge 1= acknowledged |
| room_id | Numeric Length 1-20 | 1 | Y | 72027 | This is the Agoda room ID related to the property inventory element in the YCS API version 5. Agoda active Room IDs can be returned with Getproduct request. If no room is specified in the request, all active Rooms will be returned in the response. |
| room_type | Alpha | 1 | Y | Deluxe | |
| channel_id | Numeric Length 1 | 1 | Y | 1 | Channels in YCS5 are replacing the Rateplan in YCS5. Channels are aimed to expand or limit customer type and usually will have price discount or sale limitations: 1 Retail 2 Agoda Private Sale 6 Domestic 7 Mobile 8 Agoda Opaque 9 China |
| channel_name | Alpha | 1 | Y | Retail | |
| rateplan_id | Numeric Length 1-6 | 1 | Y | 1 to 6 | This is the Agoda Rateplan ID related to a particular offer active on a room. Agoda active Rate Type IDs can be returned with Getproduct request. If no Rateplan ID is specified in the request, all active Rateplans will be returned in the response. |
| rateplan_name | Alpha | 1 | N | Breakfast | |
| promotion_id | Numeric Length 1 | 1 | N | 1184215 | Defines the ID related to a Promotion activate on a specific rateplan. |
| promotion_name | Alpha | 1 | N | Early Booking Saver Rate includes 15% discount! | |
| room_count | Numeric Length 1 | 1 | Y | 1 | Number of rooms booked in the same booking ID. |
| adults | Numeric Length 1 | 1 | Y | 2 | Number of Adults booked in booking. If multiple rooms are booked this number will be total adults for all bookings |
| children | Numeric Length 1 | 1 | Y | 1 | Number of Children booked in booking. If multiple rooms are booked this number will be total adults for all bookings |
| extrabeds | Numeric Length 1 | 1 | Y | 1 | Lists the number of extra beds that are booked in the booking. Any extra bed costs will be listed in the price type = "Extrabed". |
| cxl_code | String | 1 | Y | 1D1N_1N = cancell within 1 day 1 night charge, no show 1 night charge 365D100P_100P = non refundable | All cancellation policies contain 3 policy elements. Polices are set in order and policy 3 is always no-show policy and will list days as 0. The Policies value relates to a value or percentage |
| customer first_name | String | 1 | Y | Mary | The first name of the guest for the booking |
| last_name | String | 1 | Y | Wong | The last name of the guest for the booking |
| nationality | String | 1 | Y | Thailand | The nationality of the guest making the booking |
| String | 1 | N | [email protected] | The email address of Agoda messaging service used to facilitate communication between guest and property up to 50 characters | |
| phone | String | 1 | N | 0811234567 | The phone number of guest if ‘customer info’ is activated for the property |
| benefits benefit benefit_id | Numeric Length 1 | 1 to 9 | N | 5 | Denotes of upto 5 benefits linked to the Rate Plan booked. Refer to benefits list for the full list of benefits available. |
| benefit_name | Alpha | 1 to 9 | N | Lunch | Denotes of upto 5 benefits linked to the Rate Plan booked. Refer to benefits list for the full list of benefits available. |
| requests request request_name | Alpha | unbounded | N | NonSmoke | Denotes of special requests the customer can ask when create a booking: NonSmoke LateCheckIn EarlyCheckIn HighFloor LargeBed TwinBeds AirportTransfer:{0} AdditionalNotes:{0} FlightNo:{0} ArrivalFlightNo:{0} DepartFlightNo:{0} |
| payment card_type | Alpha | 1 | N | Mastercard | Credit card type for booking – will always show as Mastercard for all bookings as this is the Agoda card type for UPC card. |
| card_number | Numeric Length 16 | 1 | N | 503444796022XXXX | Number of the Agoda UPC (Unique Plastic Card) used by the property to debit the amount of the booking. |
| card_name | Alpha | 1 | N | Agoda Company Pte Ltd. | Name on credit card. For all bookings will show ‘Agoda Pte Ltd.’ |
| card_exp | Date MM/YYYY | 1 | N | 10/2017 | Credit card expiry date |
| card_cvv | Numeric | 1 | N | 170 | Credit card CCV number |
| card_effective_date | Date MM/YYYY | 1 | N | 10/2017 | Credit card Effective Date. If you would like this attribute to appear in the API response, kindly contact Agoda Connectivity Support for further assistance. |
| card_current_balance | Numeric nnn.nn | 1 | N | 763.27 | Credit card Current Balance. If you would like this attribute to appear in the API response, kindly contact Agoda Connectivity Support for further assistance. |
| card_future_balance | Numeric nnn.nn | 1 | N | 763.27 | Credit card Future Balance. If you would like this attribute to appear in the API response, kindly contact Agoda Connectivity Support for further assistance. |
| card_currency_code | Alpha 3 | 1 | N | USD | Credit card currency code. If you would like this attribute to appear in the API response, kindly contact Agoda Connectivity Support for further assistance. |
| card_is_vcc | boolean | 1 | N | TRUE or 1 | Is Virtual credit card (VCC). If you would like this attribute to appear in the API response, kindly contact Agoda Connectivity Support for further assistance. |
| prices currency | Alpha 3 | 1 | Y | 763.27 | Denotes type of rates is returned in the GetBookingDetails response. Net inc = net exc + taxes + fees |
| net_inclusive_amt | Numeric nnn.nn | 1 | Y | 763.27 | Denotes type of rates is returned in the GetBookingDetails response. Net inc = net exc + taxes + fees |
| net_exclusive_amt | Numeric nnn.nn | 1 | N | 693.88 | Net exc = net price without taxes and commission |
| sell_inclusive_amt | Numeric nnn.nn | 1 | N | 919.60 | Sell inc = net exc + taxes + fees + commissions |
| sell_exclusive_amt | Numeric nnn.nn | 1 | N | 836.00 | Sell exc = net exc + commissions |
| tax_amt | Numeric nnn.nn | 1 | N | 69.39 | |
| fees_amt | Numeric nnn.nn | 1 | N | 0.00 | |
| refsell_amt | Numeric nnn.nn | 1 | N | 919.60 | Refsell = net exc + taxes + fees + commissions + mandatory surcharge |
| type | 1 | N | Cancellation | Denotes the type of attribute the charge is referred to. Types are: Room Surcharge Extrabed Cancellation Other | |
| paymentmodel | Numeric | 0 to 1 | N | 1 | Payment model will be returned for channel manager participated Property Collect. Payment model can be 1 or 2 1 = Merchance booking (Agoda Collect) 2 = Agency booking (Property Collect) |
Updated 17 days ago