IKAROS POS Help
← All articles

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

  1. The PMS reads the rooms (GET …/hotel/rooms) and matches them on the Room code at the PMS.
  2. 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.
  3. Staff charge to the room at the till.
  4. The PMS takes the charges (GET …/hotel/charges?unconfirmed=1) with items, VAT, receipt number and ΜΑΡΚ, or hears about them at once through the room_charge.created webhook.
  5. 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

  1. Switches on the Hotel PMS link add-on.
  2. Under Hotel & PMS picks Hotel API (the PMS takes them itself).
  3. 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.

See also

AI menu assistantA menu from a photo or text, extras and choices, translations, descriptions and allergens with AI. You check everything before it is saved. Ask your shop (AI assistant)Ask about your sales in plain words and get an answer with numbers, a summary after each day close and a weekly note. Add-on at €7 a month. Printers and IKAROS BridgeHow kitchen and till printers connect through a PC or an Android tablet. Printing from an Android tablet (no PC)The store's tablet does the Bridge's job, with one line in Termux.