This API provides you all historical bookings information based on reservation dates of both past and future as per your needs. The API can return data in XML formats. The web service responds to HTTP POST requests.
End Point URL
Header
Parameter
| Name | Data Type | Description | Example |
| Request_Type * | VARCHAR(250) | Use Keyword “Booking” | |
| HotelCode * | INT(11) | Unique Hotel code | XXXX |
| AuthCode * | VARCHAR(300) | Unique Authentication code | XXXXXXXXXXXXXXXXX |
| FromDate * | DATE | To send a from date | 2020-07-05 |
| ToDate * | DATE | To send a to date | 2020-07-06 |
Request
<RES_Request> <Request_Type>Booking</Request_Type> <Authentication> <HotelCode>xxxx</HotelCode> <AuthCode>xxxxxxxxxx</AuthCode> </Authentication> <FromDate>2020-03-05</FromDate> <ToDate>2020-03-06</ToDate> </RES_Request>
Response
| Name | Data Type | Description | Example |
| LocationId | INT(11) | Hotel code | xxxx |
| UniqueID | VARCHAR(255) | Unique Booking id | 10125, 86436, B4525 etc |
| BookedBy | VARCHAR(255) | Information regarding Booked by | Booking.com etc |
| Salutation, FirstName, LastName, Gender, Address, City, State, Country, Zip Code, Phone, Mobile, Fax, Email. | VARCHAR(255) | Here * denotes guest information likeSalutation, FirstName, LastName, Gender, Address, City, State, Country, Zip Code, Phone, Mobile, Fax, Email. | shown in JSON response below. |
| BusinessSource | VARCHAR(100) | Business Source Name | |
| Source | VARCHAR(1000) | Booking generated source | Booking.com etc |
| IsChannelBooking | INT(1) | Is booking comes from channel [0 or 1]1 : Booking from the channel.0: Booking not from the channel. | 0 or 1 |
| BookingTran. SubBookingId | VARCHAR(255) | Sub booking Id | 138 |
| BookingTran. TransactionId | INT(20) | Booking Transaction ID | 112500000000000163 |
| BookingTran.Createdatetime | DATETIME | Booking created date time | 2020-03-16 12:00:58 |
| BookingTran.Modifydatetime | DATETIME | Booking modified date time | 2020-03-16 12:00:58 |
| BookingTran. Status | VARCHAR(1000) | Booking Status | New or Modify. |
| BookingTran.IsConfirmed | INT(1) | Booking Confirmation Flag. [1 or 0] 1 : Confirmed0 : Not Confirmed | 1 or 0. |
| BookingTran.CurrentStatus | VARCHAR(100) | Booking Current Status EX : Confirm, Check-In, Check-Out, etc | Check-In |
| BookingTran. VoucherNo | VARCHAR(255) | Booking Voucher No | 10203049/8512 |
| BookingTran. PackageCode | INT(20) | Package Code | 112500000000000001 |
| BookingTran. PackageName | VARCHAR(1000) | Package Name | European Plan etc |
| BookingTran. RateplanCode | INT(20) | Unique RatePlan Code | 112500000000000006 |
| BookingTran. RateplanName | STRING(1000) | RatePlan Name | Grand Sea View Junior Suite |
| BookingTran. eZeePMSRoomid | INT(20) | eZee PMS Room Id | 106 |
| BookingTran. RoomTypeCode | INT(20) | Unique RoomType Code | 112500000000000006 |
| BookingTran. RoomTypeName | STRING(1000) | RoomType Name | Garden View Studio Room |
| BookingTran. Start | DATETIME | Check-in date [Format : yyyy-mm-dd] | 2017-12-25 |
| BookingTran. End | DATETIME | Check-out date [Format : yyyy-mm-dd] | 2017-12-27 |
| BookingTran. CurrencyCode | VARCHAR(255) | Currency code | INR |
| BookingTran.TotalRate | DECIMAL(19,4) | Rate on room in amount | 1500.43 |
| BookingTran.TotalAmountAfterTax | DECIMAL(19,4) | Total amount after tax | 1500.43 |
| BookingTran.TotalAmountBeforeTax | DECIMAL(19,4) | Total amount before tax | 1200 |
| BookingTran.TotalTax | DECIMAL(19,4) | Total tax | 300.43 |
| BookingTran. TotalDiscount | DECIMAL(19,4) | Discount on room in amount | 500 |
| BookingTran. TotalExtraCharge | DECIMAL(19,4) | Extra charges in amount(if any) | 300 |
| BookingTran. TotalPayment | DECIMAL(19,4) | Payment for room in amount | 2500.54 |
| BookingTran.* | – | Here * denotes guest informations likeSalutation, FirstName, LastName, Gender, DateOfBirth, SpouseDateOfBirth, WeddingAnniversary, Nationality, Address, City, State, Country, Zip Code, Phone, Mobile, Fax, Email,IdentityType, IdentityNo, ExpiryDate. | |
| BookingTran. TransportationMode | VARCHAR(100) | Mode of transportation | Bus, car etc |
| BookingTran. Vehicle | VARCHAR(255) | Detail of vehicle | |
| BookingTran. PickupDate | DATETIME | Pickup date [Format : yyyy-mm-dd] | 2017-12-25 etc |
| BookingTran. PickupTime | DATETIME | Pickup time | |
| BookingTran. Source | VARCHAR(1000) | Booking generated source | Booking.com |
| BookingTran. Comment | VARCHAR(1000) | Additional Information or comment. | |
| BookingTran. AffiliateName | VARCHAR(1000) | Booking Affiliate Name | |
| BookingTran.AffiliateCode | VARCHAR(1000) | Booking Affiliate Code | |
| BookingTran.* | – | Here * denotes information like Credit Card Informations likeCCLink, CCNo, CCType,CardHolderName, CCExpiryDate, | |
| BookingTran.ExtraCharge .* | – | here * denotes ChargeDate,ChargeCode, ChargeName, ChargeDesc,Remark,Quantity, AmountBeforeTax,Amount | |
| BookingTran.RentalInfo.EffectiveDate | DATETIME | Booking details for particular effective date | 2017-12-25 etc |
| BookingTran.RentalInfo.PackageCode | INT(20) | Package code | 112500000000000001 |
| BookingTran.RentalInfo.PackageName | VARCHAR(1000) | Package Name | European Plan |
| BookingTran.RentalInfo.R oomTypeCode | INT(20) | Unique RoomType Code | 112500000000000006 |
| BookingTran.RentalInfo.R oomTypeName | STRING(1000) | RoomType Name | Grand Sea View Junior Suite |
| BookingTran.RentalInfo.Adult | INT(11) | No. of Adults | 2,3,4 etc |
| BookingTran. RentalInfo.Child | INT(11) | No. of Childs | 2,3,4 etc |
| BookingTran. RentalInfo.Rent | DECIMAL(19,4) | Room rental amount | 1500.43 |
| BookingTran. RentalInfo.Discount | DECIMAL(19,4) | Discount on rental room in amount | 500 |
| BookingTran. Sharer. * | – | Here * denotes informations likeSalutation, FirstName, LastName, Gender, DateOfBirth, SpouseDateOfBirth, WeddingAnniversary, Nationality, Address, City, State, Country, Zip Code, Phone, Mobile, Fax, Email,IdentityType, IdentityNo, ExpiryDate. | |
| Errors.ErrorCode | – | Response Error Code | 104, 404 etc |
| Errors.ErrorMessage | – | Generate Response Message | Unauthorized Request. etc |
Success
<?xml version="1.0" encoding="UTF-8"?><RES_Response>
<Reservations>
<Reservation>
<BookByInfo>
<LocationId>8943</LocationId>
<UniqueID>11</UniqueID>
<BookedBy>Joy Smith</BookedBy>
<Salutation>Mr.</Salutation>
<FirstName>Joy</FirstName>
<LastName>Smith</LastName>
<Gender>Male</Gender>
<Address></Address>
<City></City>
<State></State>
<Country>India</Country>
<Zipcode></Zipcode>
<Phone></Phone>
<Mobile></Mobile>
<Fax></Fax>
<Email></Email>
<BusinessSource>Booking.com</BusinessSource>
<Source>PMS</Source>
<IsChannelBooking>0</IsChannelBooking>
<BookingTran>
<SubBookingId>11</SubBookingId>
<TransactionId>894300000000000010</TransactionId>
<Createdatetime>2020-03-05 12:00:58</Createdatetime>
<Modifydatetime>2020-03-16 12:00:58</Modifydatetime>
<Status>New</Status>
<IsConfirmed>1</IsConfirmed>
<CurrentStatus>Check-In</CurrentStatus>
<VoucherNo></VoucherNo>
<PackageCode>894300000000000002</PackageCode>
<PackageName>All Inclusive</PackageName>
<RateplanCode>894300000000000013</RateplanCode>
<RateplanName>Studio All Inclusive</RateplanName>
<eZeePMSRoomid>106</eZeePMSRoomid>
<RoomTypeCode>894300000000000001</RoomTypeCode>
<RoomTypeName>Studio</RoomTypeName>
<Start>2020-03-17</Start>
<End>2020-03-20</End>
<CurrencyCode>INR</CurrencyCode>
<TotalRate>8850.00</TotalRate>
<TotalAmountAfterTax>8850.00</TotalAmountAfterTax>
<TotalAmountBeforeTax>7500.00</TotalAmountBeforeTax>
<TotalTax>1350.00</TotalTax>
<TotalDiscount>0.00</TotalDiscount>
<TotalExtraCharge>15.00</TotalExtraCharge>
<TotalPayment>8865.00</TotalPayment>
<PayAtHotel>false</PayAtHotel>
<TACommision>0.00</TACommision>
<Salutation>Mr.</Salutation>
<FirstName>Joy</FirstName>
<LastName>Smith</LastName>
<Gender>Male</Gender>
<DateOfBirth></DateOfBirth>
<SpouseDateOfBirth></SpouseDateOfBirth>
<WeddingAnniversary></WeddingAnniversary>
<Nationality></Nationality>
<Address></Address>
<City></City>
<State></State>
<Country>India</Country>
<Zipcode></Zipcode>
<Phone></Phone>
<Mobile></Mobile>
<Fax></Fax>
<Email></Email>
<IdentiyType>Aadhar card</IdentiyType>
<IdentityNo>12315346546</IdentityNo>
<ExpiryDate></ExpiryDate>
<TransportationMode></TransportationMode>
<Vehicle></Vehicle>
<PickupDate></PickupDate>
<PickupTime></PickupTime>
<Source>PMS</Source>
<Comment></Comment>
<AffiliateName></AffiliateName>
<AffiliateCode></AffiliateCode>
<CCLink></CCLink>
<CCNo></CCNo>
<CCType></CCType>
<CCExpiryDate></CCExpiryDate>
<CardHoldersName></CardHoldersName>
<ExtraCharge>
<ChargeDate>2020-03-18</ChargeDate>
<ChargeCode></ChargeCode>
<ChargeName>Call Charges</ChargeName>
<ChargeDesc></ChargeDesc>
<Remark></Remark>
<Quantity>15</Quantity>
<AmountBeforeTax>15.00</AmountBeforeTax>
<Amount>15.00</Amount>
</ExtraCharge>
<RentalInfo>
<EffectiveDate>2020-03-18</EffectiveDate>
<PackageCode>894300000000000002</PackageCode>
<PackageName>All Inclusive</PackageName>
<RoomTypeCode>894300000000000001</RoomTypeCode>
<RoomTypeName>Studio</RoomTypeName>
<Adult>2</Adult>
<Child>2</Child>
<Rent>2950.00</Rent>
<RentBeforeTax>2500.00</RentBeforeTax>
<Discount>0.00</Discount>
</RentalInfo>
<RentalInfo>
<EffectiveDate>2020-03-19</EffectiveDate>
<PackageCode>894300000000000002</PackageCode>
<PackageName>All Inclusive</PackageName>
<RoomTypeCode>894300000000000001</RoomTypeCode>
<RoomTypeName>Studio</RoomTypeName>
<Adult>2</Adult>
<Child>2</Child>
<Rent>2950.00</Rent>
<RentBeforeTax>2500.00</RentBeforeTax>
<Discount>0.00</Discount>
</RentalInfo>
<Sharer>
<Salutation>Mam.</Salutation>
<FirstName>Maya</FirstName>
<LastName></LastName>
<Gender>Female</Gender>
<DateOfBirth></DateOfBirth>
<SpouseDateOfBirth></SpouseDateOfBirth>
<WeddingAnniversary></WeddingAnniversary>
<Nationality>India</Nationality>
<Address></Address>
<City></City>
<State></State>
<Country>India</Country>
<Zipcode></Zipcode>
<Phone></Phone>
<Mobile></Mobile>
<Fax></Fax>
<Email></Email>
<IdentiyType>Aadhar card</IdentiyType>
<IdentityNo>789456123</IdentityNo>
<ExpiryDate></ExpiryDate>
</Sharer>
</BookingTran>
</BookByInfo>
</Reservation>
<CancelReservation>
<LocationId>8943</LocationId>
<UniqueID>206-1</UniqueID>
<Remark>Cancel,Guest want to cancel reservation through Agoda</Remark>
<VoucherNo>12314986/1</VoucherNo>
</CancelReservation>
<CancelReservation>
<LocationId>8943</LocationId>
<UniqueID>206-2</UniqueID>
<Remark>Cancel,Guest want to cancel reservation through Agoda</Remark>
<VoucherNo>12314944/2</VoucherNo>
</CancelReservation>
<CancelReservation>
<LocationId>8943</LocationId>
<UniqueID>207</UniqueID>
<Remark>Cancel,Guest want to cancel reservation through Agoda</Remark>
<VoucherNo>123149844/1</VoucherNo>
</CancelReservation>
<CancelReservation>
<LocationId>8943</LocationId>
<UniqueID>200</UniqueID>
<Remark>Cancel,Guest want to cancel reservation through Agoda</Remark>
<VoucherNo>123149444</VoucherNo>
</CancelReservation>
</Reservations>
<Errors>
<ErrorCode>0</ErrorCode>
<ErrorMessage>Success</ErrorMessage>
</Errors>
</RES_Response>
Error Codes
| Error Code | Error Name |
| 114 | Missing from date in some request |
| 115 | Missing to date in some request |
| 117 | From Date is not valid date |
| 118 | To Date is not valid date |
| 119 | Please check From and To date. To Date should be greater than From Date |
| 113 | Missing roomtype id in some request |
| 400 | Invalid Request Format |
| 302 | Authentication failed |
| 303 | Auth Code is inactive. |
| 301 | Unauthorized request. Request is not valid for this hotel code |
| 202 | Unauthorized request. Hotel code is not active |
| 111 | Invalid Request |
| 204 | Duplicate request. Please try again after 1 minute. |