Core Concepts
The core entities and terms of the Hostme API — restaurant, reservation, guest, table, floor — that an integration is built on.
The core entities and terms an integration is built on.
Restaurant
The central entity. Almost all endpoints are addressed by the numeric restaurantId:
/api/.../restaurants/{restaurantId}/.... One set of credentials (account) can have access
to several restaurants — their list and ids are returned by GET /api/core/admin/account/me.
Restaurant profile (opening hours, contacts, settings) — see Restaurant Info.
Reservation (booking)
A record of a guest’s visit: date and time, party size (groupSize), guest, table, status.
Lifecycle: created → confirmed → guest is seated → visit ends (or is canceled / no-show).
| Concept | Description |
|---|---|
reservationTime | Date and time of the visit (restaurant local time) |
groupSize | Number of guests |
tableNumber | Assigned table (may be assigned automatically) |
source | Booking source (e.g. your app/widget) |
state / status | Current state of the booking |
additionals | Flags and requests (VIP, high chair, allergy, etc.) |
In detail — Reservations: Create & Manage.
Availability
Calculation of free slots and tables on a date for a given party size. It can be computed
in two ways: as for an online guest (AsOnlineGuest=true, limited slots) or as
full host availability. See Table Availability.
Booking request (request reservation)
A booking that requires host approval: it is created as a request, then approved or rejected. Useful when the restaurant wants to moderate bookings from external channels. See Booking Requests.
Guest
A guest has a profile (customerProfile): contacts, preferences (allergy, vegetarian, VIP),
delivery address, visit history. Search and creation — Guest Book.
| Concept | Description |
|---|---|
memberId | Guest identifier (string) |
customerProfile | Guest profile (preferences, contacts, address) |
guestTags | Guest tags |
Tables and floors (areas)
A restaurant is divided into floors/areas (areas) and tables. Floor plan and table states —
Tables & Floors. Areas can be specified when calculating availability (Areas).
Menu, products, orders
A menu consists of sections and products; products have modifiers and taxes. An order (order)
can be attached to a booking. See Menu: Catalog and related sections.
Token types
The behavior of some endpoints depends on the token type — Hostme, Partner, Vendor.
For example, under a Vendor token records are created “on behalf of an external app” with
VendorAppId set automatically. In detail — Authentication.
Partner app (appId)
An external app registered in Hostme has an appId. It can be used to fetch the bookings
created by that app: GET /api/rsv/partner/{appId}/reservations.
See Partner Bookings and App Registration.
Time and time zones
Booking times are in the restaurant’s local time zone (restaurants[].timeZone from /me).
Format — ISO 8601. More in Conventions.