Hotel API for PMS vendors
An open API for any PMS vendor: the PMS pushes stays, reads room charges with items, VAT and ΜΑΡΚ, and confirms the ones it booked on the folio. With the room_charge.created webhook.
If your PMS is not Hoteliga, its vendor can connect it to IKAROS POS through the Hotel API. It is open and documented, at no charge to the vendor. The full documentation, in English, is at /api/docs#hotel.
How it works
- The PMS reads the rooms (
GET …/hotel/rooms) and matches them on the Room code at the PMS. - On every check-in, change and check-out it sends the stay (
PUT …/hotel/stays/{booking}), with a charge limit and folio if it wants. - Staff charge to the room at the till.
- The PMS takes the charges (
GET …/hotel/charges?unconfirmed=1) with items, VAT, receipt number and ΜΑΡΚ, or hears about them at once through theroom_charge.createdwebhook. - After booking them on the folio it confirms them (
POST …/hotel/charges/confirm).
Each charge says invoiced_by: pos when the till issued the receipt (the PMS books it as already invoiced), pms when the hotel issues the final invoice. See Link with the hotel PMS.
What the store does
- Switches on the Hotel PMS link add-on.
- Under Hotel & PMS picks Hotel API (the PMS takes them itself).
- The owner creates under API keys a key with the permission Hotel PMS: rooms, stays, room charges and gives it to the vendor. Optionally, a webhook with the event room charge (Hotel PMS). See API keys and webhooks.
The key sees only its own store, with a limit of 120 calls a minute. Without the add-on every call answers 403.
Under Room charges charges show Waiting until the PMS confirms them, then In the PMS.