This API will give you a total extra service rate on the basis of configured Extra Charges, check in date and check out date in your property. The API can return data in JSON formats. The web service responds to HTTP GET requests.
This API will fulfill both needs to give you details for single extra charges or multiple extra charges at a time. You need to take eZee Reservation to use this API.
URI Request
Request parameters are supplied by appending a question mark (?) to the base URI, followed by a sequence of parameter names and values separated by an ampersand (&).
End Point URL
[BaseUrl]booking/reservation_api/listing.php?request_type=[Request_Type]&HotelCode=[Hotel_Code]&APIKey=[API_KEY]&check_in_date=[CHECK_IN_DATE]&check_out_date=[CHECK_OUT_DATE]&ExtraChargeId=[EXTRACHARGEID]&Total_ExtraItem=[TOTAL_EXT RAITEM]
Header
Parameter
Name | Data Type | Description | Example |
[BaseUrl] * | – | Live server URL | https://live.ipms247.com/ |
[Request_Type] * | – | Use Keyword “CalculateExtraCharge” | |
[Hotel_Code] * | INT(11) | Unique Hotel code | XXXX |
[API_KEY] * | VARCHAR(300) | Unique Authentication code | XXXXXXXXXXXXXXXX |
[CHECK_IN_DATE] * | DATE | Pass Check in date in YYYY-MM-DD format | 2020-07-05 |
[CHECK_OUT_DATE] * | DATE | Pass Check out date in YYYY-MM-DD format | 2020-07-07 |
[EXTRACHARGEID] * | VARCHAR(300) | Pass [single|multiple] extra charge id’s for your property | Single : XXX Multiple : XXX, YYY |
[TOTAL_EXT RAITEM] * | VARCHAR(300) | Pass total number of items for [single|multiple] extra charges | Single : 2 Multiple : 2, 3 Sample 1: Extra charge Rule : Per Pax, Adults : 2, Child : 1 Pass [TOTAL_EXTRAITEM] = 3 Sample 2: Extra charge Rule : Per Quantity, Quantity: 2 Pass [TOTAL_EXTRAITEM] = 2 |
Request
https://live.ipms247.com/booking/reservation_api/listing.php?request_type=CalculateExtraCharge&HotelCode=XXX&APIKey=XXX&check_in_date=XXX&check_out_date=XXX&ExtraChargeId=XXX&Total_ExtraItem=X
Response
Name | Data Type | Description | Example |
IndividualCharge | List of Individual Charge | xxx | |
TotalCharge | Total of charge | 160 |
Success
{ "IndividualCharge": { "XXX": 150, "YYY": 10 }, "TotalCharge": 160 }
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. |
getExtraChargeListError | Extra Charge List error |
-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. |