This API provides information of extra services available at your property which can be used in mapping or display purposes in the external applications. The API can return data in JSON formats.
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]&HotelCode=[Hotel_Code]&APIKey=[API_KEY]&language=[LANGUAGE];
Header
Parameter
Name | Data Type | Description | Example |
[BaseUrl] * | – | Live server URL | https://live.ipms247.com/ |
[Request_Type] * | – | Use Keyword “ExtraCharges” | |
[Hotel_Code] * | INT(11) | Unique Hotel code | XXXX |
[API_KEY] * | VARCHAR(300) | Unique Authentication code | XXXXXXXXXXXXXXXXX |
[LANGUAGE] | VARCHAR(20) | [Optional] Default is en. Pass language code. Language codes are available here. | en |
Request
https://live.ipms247.com/booking/reservation_api/listing.php?request_type=ExtraCharges&HotelCode=XXX&APIKey=XXX&language=en
Response
Name | Data Type | Description | Example |
ExtraChargeId | Integer(20) | Unique id of ExtraCharge | XXXXXXXXXXXXXXXXXX |
ShortCode | String | ShortCode of ExtraCharge | Transport |
charge | String | ExtraCharge name | Welcome Drink |
Description | String | ExtraCharge Description | |
Rate | Decimal | ExtraCharge Rate | 100 |
CharegeRule | String | Rule of ExtraCharge | PERQUANTITY |
PostingRule | String | Rule of posting ExtraCharge | ONLYCHECKOUT |
ValidFrom | Date | From date of ExtraCharge is valid | 2020-02-03 |
ValidTo | Date | To Date of Extracharge is valid | 2020-03-03 |
ischargealways | integer(1) | Is always charge or not, 0: not always charge, 1: always charge | 0 or 1 |
applyon_rateplan | Integer(20) | Rateplanid where ExtraCharge applied or ALL | XXXXXXXXXXXXXXXXXX |
applyon_special | Integer(20) | Specialid where ExtraCharge applied or ALL | ALL |
Success
[ { "ExtraChargeId": "XXXXXXXXXXXXXXXXXX", "ShortCode": "Bottle of Wine on Arrival", "charge": "Bottle of Wine on Arrival", "description": null, "Rate": "500.0000", "ChargeRule": "PERQUANTITY", "PostingRule": "ONLYCHECKOUT", "ValidFrom": null, "ValidTo": null, "ischargealways": "0", "applyon_rateplan": "XXXXXXXXXXXXXXXXXX", "applyon_special": "" }, { "ExtraChargeId": "XXXXXXXXXXXXXXXXXX", "ShortCode": "Transport", "charge": "Transport Services", "description": null, "Rate": "500.0000", "ChargeRule": "PERBOOKING", "PostingRule": "ONLYCHECKIN", "ValidFrom": null, "ValidTo": null, "ischargealways": "0", "applyon_rateplan": "ALL", "applyon_special": "ALL" } ]
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. |