This API provides you current room stats and booking information based on reservation date or arrival dates. The API can return data in JSON formats. The web service responds to HTTP GET requests.
You need to take eZee Reservation to use this API.
End Point URL
[BaseUrl]booking/reservation_api/listing.php?request_type=[Request_Type]&HotelCode=[Hotel_Code]&APIKey=[API_KEY]&created_ from=[CREATED_FROM]&created_to=[CREATED_TO]&EmailId=[Email]
Header
–
Parameter
| Name | Data Type | Description | Example |
| [BaseUrl] * | – | Live server URL | https://live.ipms247.com/ |
| [Request_Type] * | – | Use Keyword “BookingList” | |
| [Hotel_Code] * | INT(11) | Unique Hotel code | XXXX |
| [API_KEY] * | VARCHAR(300) | Unique Authentication code | XXXXXXXXXXXXXXXXX |
| [CREATED_FROM] * | Date | Date Fromformat(yyyy-mm-dd) | 2020-05-23 |
| [CREATED_TO] * | Date | Date Toformat(yyyy-mm-dd) | 2020-05-30 |
| ArrivalFrom | Date | ArrivalDate fromformat(yyyy-mm-dd) | 2020-05-22 |
| ArrivalTo | Date | ArrivalDate Toformat(yyyy-mm-dd) | 2020-05-30 |
| [Email] * | VARCHAR(100) | Booking EmailId | xxxxxx@xyz.com |
Request
https://live.ipms247.com/booking/reservation_api/listing.php?request_type=BookingList&HotelCode=XXX&APIKey=XXX&arrival_from =XXX&arrival_to=XXX&EmailId=
Response
| Name | Data Type | Description | Example |
| ReservationNo | Integer(11) | Reservation Unique number | 1 |
| GuestName | String | Name of Guest | Mr.Jhonson |
| ArrivalDate | Date | Date of arrival | 2020-02-20 |
| DepartureDate | Date | Date of Departure | 2020-02-22 |
| CancelDate | Date | Date when Reservation is cancel | 2020-02-10 |
| ReservationDate | Date | Date when Reservation is created | 2020-02-05 |
| Room | String | Room Name | Delux |
| ReservationGuarantee | String | Guarantee of reservation | Confirm booking |
| Source | String | Source of reservation | web |
| VoucherNo | Integer(11) | Voucher number | 1 |
| DueAmount | Decimal | Due Amount | 12500 |
| Deposit | Decimal | Deposit amount | 0 |
| Status | String | Status of booking | Active |
| BookingStatus | String | Current Status of booking | Confirmed Reservation |
| Transaction Status | String | Status of transaction | Complete Booking |
| Total Tax | Decimal | Total Tax amount | 500 |
| TotalInclusiveTax | Decimal | Total Inclusive Tax Amount | 1500 |
| TotalExclusivTax | Decimal | Total Exclusive Amount | 1000 |
| OtherRevenueExclusiveTax | Decimal | Other Revenue tax exclusive amount | 1200 |
| OtherRevenueInclusiveTax | Decimal | Other Revenue tax inclusive amount | 1500 |
| FolioNo | String | Folio NUmber | A123 |
BaseRateExclusiveTax, BaseRateInclusiveTax | |||
| TransactionDate | Date | Date of transaction | |
| ChargeName | String | Name of charge | |
| ChargeAmount | Decimal | Charge amount |
Success
{
"SearchCriteria": {
"arrival_from": "2020-03-15",
"arrival_to": "2020-05-30"
},
"RoomList": {
"TotalActiveRoomInHotel": 1155,
"TotalBlockRooms": 0,
"TotalOccupiedRooms": 8
},
"BookingList": [
{
"ReservationNo": "RV506",
"GuestName": "Mr. Anis",
"ArrivalDate": "2020-05-08",
"DepartureDate": "2020-05-12",
"CancelDate": "",
"ReservationDate": "2020-05-08",
"Room": "Garden View",
"RoomShortCode": "GV",
"ReservationGuarantee": "Confirm Booking",
"Source": "Ajay Tours and Travels",
"VoucherNo": "-",
"Mobile": "-",
"Address": "",
"Email": "nishit.vankawala@ezeetechnosys.com",
"Country": "India",
"Adult": "1",
"Child": "0",
"Phone": "-",
"NoOfGuest": 1,
"NoOfNights": "4",
"salutation": "Mr.",
"FirstName": "Anis",
"LastName": "",
"DueAmount": 13200,
"Deposit": 0,
"Status": "Active",
"BookingStatus": "Confirmed Reservation",
"TransactionStatus": "Complete Booking",
"Total Tax": 1345.44,
"TotalInclusiveTax": 13200,
"TotalExclusivTax": 11854.56,
"OtherRevenueExclusiveTax": 2000,
"OtherRevenueInclusiveTax": 2360,
"FolioNo": "GF759",
"BaseRateExclusiveTax": {
"2020-05-08": 2463.64,
"2020-05-09": 2463.64,
"2020-05-10": 2463.64,
"2020-05-11": 2463.64
},
"BaseRateInclusiveTax": {
"2020-05-08": 2710,
"2020-05-09": 2710,
"2020-05-10": 2710,
"2020-05-11": 2710
},
"ExtraCharges": {
"2020-05-08": [
{
"TransactionDate": "2020-05-08",
"ChargeName": "Pool's",
"ChargeAmount": "500.0000"
},
{
"TransactionDate": "2020-05-08",
"ChargeName": "CGST@6%",
"ChargeAmount": "90.0000"
}
],
"2020-05-09": [
{
"TransactionDate": "2020-05-09",
"ChargeName": "Pool's",
"ChargeAmount": "500.0000"
},
{
"TransactionDate": "2020-05-09",
"ChargeName": "CGST@6%",
"ChargeAmount": "90.0000"
}
],
"2020-05-10": [
{
"TransactionDate": "2020-05-10",
"ChargeName": "Pool's",
"ChargeAmount": "500.0000"
},
{
"TransactionDate": "2020-05-10",
"ChargeName": "CGST@6%",
"ChargeAmount": "90.0000"
}
],
"2020-05-11": [
{
"TransactionDate": "2020-05-11",
"ChargeName": "Pool's",
"ChargeAmount": "500.0000"
},
{
"TransactionDate": "2020-05-11",
"ChargeName": "CGST@6%",
"ChargeAmount": "90.0000"
}
]
}
}
]
}
Error Codes
| Error Code | Error Name |
| HotelCodeEmpty | Hotel code is empty. |
| NORESACC | This request is valid for Reservation Account only. You may not have opted for Reservation Account Or Hotel Code and Authentication are invalid. |
| UNAUTHREQ | Unauthorized request. This request is not valid for this hotel code. |
| 2 | Cannot Parse Request |
| 5 | Recoverable Error. Equivalent to http 503. |
| CheckDate | Check out date should be greater than Check in date |
| DBConnectError | Database not connected. |
| BookingListLimitExceed | You can not request data of more than 365 days. |
| -1 | No Data found. |
| APIACCESSDENIED | Your property doesn’t have access to API integration or Key is incorrect. Please contact support for this. |
| ParametersMissing | Missing parameters. |
| UnknownError | Unknown Error |
| 4 | Timeout requested. Stops requests for the specified time. |
| InvalidHotelCode | Invalid Hotel code.Please check your property code. |
| BadRequest | Bad request type. |
| getBookingListError | Booking List error |