Рестораны
Поиск ресторанов, получение информации, расписание и свободные столы через API
API GuestMe предоставляет эндпоинты для поиска ресторанов, получения детальной информации, проверки расписания и наличия свободных столов.
Структура данных ресторана
Каждый ресторан представлен объектом RestaurantExternalDto со следующими полями:
Поле | Тип | Обязательное | Описание |
|---|---|---|---|
|
| да | Уникальный ID ресторана в GuestMe |
|
| да | Название ресторана |
|
| да | ACTIVE, INACTIVE или DELETED |
|
| нет | Описание ресторана |
|
| да | Адрес (country, city, street, home, point) |
|
| да | Контакты (phone, site, telegram, vk, iikoUid) |
|
| да | Свойства (phoneConfirmationEnabled, guestAcquisitionChannelEnabled) |
Поиск ресторанов
GET /api/v1/external/restaurant — постраничный поиск ресторанов по названию и адресу.
Параметры запроса
Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
|
| нет | Текст для поиска по названию и адресу |
|
| нет | ID ресторанов для исключения из результатов |
|
| да | Номер страницы (начиная с 0) |
|
| да | Размер страницы |
Получение ресторана по ID
GET /api/v1/external/restaurant/{id} — получение ресторана по его GuestMe ID.
Поиск по ID партнёрской системы
GET /api/v1/external/restaurant/find/partner/{id} — поиск ресторана по идентификатору внешней системы (iiko, r_keeper).
В качестве {id} передаётся UID ресторана из POS-системы, например 123-456-789.
Свободные столы
GET /api/v1/external/restaurant/{id}/table/free/count — количество свободных столов на заданную дату и число гостей.
Параметры
Параметр | Тип | Описание |
|---|---|---|
|
| ID ресторана (в path) |
|
| Дата и время бронирования (ISO 8601) |
|
| Количество гостей |
Расписание ресторана
GET /api/v1/external/restaurant/{id}/schedule — получение расписания работы ресторана.
Расписание возвращается в виде массива RestaurantScheduleGroupDto. Каждая запись содержит день недели, тип расписания и временные интервалы.
Типы расписания
Тип | Описание |
|---|---|
| Часы работы ресторана |
| Часы приёма бронирований (могут отличаться от часов работы) |
Перед созданием бронирования убедитесь, что свойство guestAcquisitionChannelEnabled ресторана равно true. Это означает, что ресторан подключил канал привлечения гостей и готов принимать бронирования через API.