Retrieve Extras

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

NameData TypeDescriptionExample
[BaseUrl] *Live server URLhttps://live.ipms247.com/
[Request_Type] *Use Keyword “ExtraCharges”
[Hotel_Code] *INT(11)Unique Hotel codeXXXX
[API_KEY] *VARCHAR(300)Unique Authentication codeXXXXXXXXXXXXXXXXX
[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

NameData TypeDescriptionExample
ExtraChargeIdInteger(20)Unique id of ExtraChargeXXXXXXXXXXXXXXXXXX
ShortCodeStringShortCode of ExtraChargeTransport
chargeStringExtraCharge nameWelcome Drink
DescriptionStringExtraCharge Description
RateDecimalExtraCharge Rate100
CharegeRuleStringRule of ExtraChargePERQUANTITY
PostingRuleStringRule of posting ExtraChargeONLYCHECKOUT
ValidFromDateFrom date of ExtraCharge is valid2020-02-03
ValidToDateTo Date of Extracharge is valid2020-03-03
ischargealwaysinteger(1)Is always charge or not,
0: not always charge,
1: always charge
0 or 1
applyon_rateplanInteger(20)Rateplanid where ExtraCharge applied or ALLXXXXXXXXXXXXXXXXXX
applyon_specialInteger(20)Specialid where ExtraCharge applied or ALLALL

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 CodeError Name
HotelCodeEmptyHotel code is empty.
NORESACCThis request is valid for Reservation Account only. You may not have opted for Reservation Account Or Hotel Code and Authentication are invalid.
UNAUTHREQUnauthorized request. This request is not valid for this hotel code.
2Cannot Parse Request
5Recoverable Error. Equivalent to http 503.
CheckDateCheck out date should be greater than Check in date
DBConnectErrorDatabase not connected.
getExtraChargeListErrorExtra Charge List error
-1No Data found.
APIACCESSDENIEDYour property doesn’t have access to API integration or Key is incorrect. Please contact support for this.
ParametersMissingMissing parameters.
UnknownErrorUnknown Error
4Timeout requested. Stops requests for the specified time.
InvalidHotelCodeInvalid Hotel code.Please check your property code.
BadRequestBad request type.

Click here to Register