Ваш ресторан.
Ваши правила работы.
Настраивайте Waitly через интеграцию или ИИ. У них один каталог операций и один исполнитель: параметры, права и результат совпадают.
https://api.waitly.uz · JSON · 175 операций в каталогеПервый запрос
Создайте ключ в разделе «Доступ → API-ключи» кабинета. Секрет wsk_… показывается при создании. Храните его на своём сервере; публичный идентификатор wpk_… для авторизации не подходит.
export WAITLY_API_KEY='YOUR_SECRET_KEY' curl 'https://api.waitly.uz/api/v2/restaurants/' \ -H "X-API-Key: $WAITLY_API_KEY"
Возьмите id нужного заведения из data. Затем получите операции, доступные вашему ключу:
curl 'https://api.waitly.uz/api/v2/restaurants/RESTAURANT_UUID/capabilities/?module=settings' \ -H "X-API-Key: $WAITLY_API_KEY"
Реальные UUID приходят от API. Значения RESTAURANT_UUID и YOUR_SECRET_KEY в примерах — места для подстановки.
Доступ привязан к заведению
Ключ RESTAURANT действует на одну точку, CHAIN — на сеть, OWNER — на заведения владельца. Дополнительно выдайте права нужных операций: например, settings.read и settings.write. В v2 пустые permissions не дают неявного доступа к операциям.
Передайте Authorization: Bearer OWNER_JWT. Назначение сотрудником не даёт прав владельца. Идентификатор чужого заведения возвращает 404. В теле команды нельзя подменить выбранное заведение.
Выдать конкретные права существующему ключу можно по JWT владельца. Новые permissions заменяют прежний список, поэтому передайте все права, которые хотите сохранить:
PATCH /api/public-api/keys/KEY_UUID/
Authorization: Bearer OWNER_JWT
Content-Type: application/json
{"permissions":["settings.read","settings.write"]}ИИ тоже умеет выпустить ключ с нужными permissions через подтверждение владельца.
Ключи сохраняют лимиты запросов, дневные квоты, срок действия и IP allowlist. Права payments.read/payments.write требуют отдельного разрешения владельца. Ключ интеграции не может нажать подтверждение за владельца.
Одна операция — один понятный результат
Каждая операция вызывается через POST. Тело — объект, описанный в её input_schema. Для изменений обязателен Idempotency-Key: повтор того же запроса не создаст второй документ.
curl -X POST \
'https://api.waitly.uz/api/v2/restaurants/RESTAURANT_UUID/operations/settings.profile.update/' \
-H "X-API-Key: $WAITLY_API_KEY" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: profile-address-001' \
-d '{"address":"Ташкент, ул. Примерная, 10","receipt_footer":"Спасибо, что заглянули!"}'Успех возвращает {"data": …, "meta": {"api_version": "2", "request_id": …}}. Идентификатор запроса есть и в заголовке X-Request-ID. При повторе команды data.replayed будет true. Другие параметры с тем же ключом дают 409.
Подтверждение важных изменений
Ответ 202 и data.status = "confirm" означают, что действие ожидает владельца. Для подтверждения или отмены используйте JWT того же владельца:
POST /api/v2/restaurants/RESTAURANT_UUID/confirmations/PENDING_UUID/
Authorization: Bearer OWNER_JWT
Content-Type: application/json
{"confirm": true}Повторное, просроченное или чужое подтверждение отклоняется. {"confirm": false} отменяет действие.
Свои таблицы и поля
records.create создаёт запись пользовательской коллекции. Поля data задаёте вы. records.update объединяет переданные поля с существующими. Чтение поддерживает limit/offset и возвращает next_offset.
POST …/operations/records.create/
Idempotency-Key: equipment-001
{"slug":"equipment","data":{"name":"Кофемолка","service_interval_days":30}}
Меню, касса, оформление, приложения и автоматизации расширяются в границах своего заведения. Платёжные комиссии платформы, чужие данные и серверные секреты не являются настройками ресторана. Изменение исходного кода компонентов меню проходит отдельную проверку и публикацию.
Получать события через webhooks
Владелец подключает свой сервер через backoffice.webhooks.create по JWT. Ключ интеграции не может создать получателя или получить подписывающий секрет. Все операции ниже используют тот же URL …/operations/OPERATION_ID/ и контракт подтверждений.
{
"name": "Моя учётная система",
"url": "https://erp.example.com/hooks/waitly",
"events": ["order.created", "order.updated"],
"is_active": false
}После подтверждения сохраните signing_secret на принимающем сервере. Список получателей его не показывает. Затем вызовите backoffice.webhooks.update с {"endpoint_id":"ENDPOINT_UUID","is_active":true} и подтвердите включение. Для смены секрета используйте rotate_secret:true. URL должен быть публичным HTTPS на порту 443, без query, логина и пароля; внутренние адреса и перенаправления запрещены.
Что приходит
Доступны order.created, order.updated, stock.movement и platform.operation. Событие содержит UUID заведения и объекта, тип и состояние; контакты клиентов и аргументы команд не передаются. Детали объекта запрашивайте отдельно с правами своего заведения.
{
"id": "EVENT_UUID",
"type": "order.updated",
"restaurant_id": "RESTAURANT_UUID",
"created_at": "2026-10-18T12:00:00+00:00",
"data": {"object_id": "ORDER_UUID", "state": "READY"}
}
Проверить подпись и принять без дублей
Заголовки: X-Waitly-Timestamp, X-Waitly-Signature, X-Waitly-Event-ID, X-Waitly-Delivery-ID. Подпись считается по исходным байтам HTTP-тела до разбора JSON. Проверяйте временную метку (например, окно 5 минут при синхронизированных часах) и сравнивайте подписи за постоянное время.
import hashlib, hmac, time
# raw_body: bytes, headers: HTTP headers, secret: server-side secret
timestamp = headers["X-Waitly-Timestamp"]
if abs(time.time() - int(timestamp)) > 300:
raise ValueError("Expired timestamp")
expected = "sha256=" + hmac.new(
secret.encode(), timestamp.encode() + b"." + raw_body,
hashlib.sha256,
).hexdigest()
if not hmac.compare_digest(expected, headers["X-Waitly-Signature"]):
raise ValueError("Invalid signature")Доставка допускает повторы и не гарантирует порядок. После проверки подписи сохраняйте событие с уникальным event id в своей очереди и быстро отвечайте 2xx; повтор уже принятого события тоже подтверждайте 2xx. Event id и delivery id сохраняются при повторных попытках. HTTP 408, 409, 425, 429, 5xx и сетевые ошибки повторяются с паузой, до 8 попыток; остальные неуспешные HTTP-ответы завершают доставку.
Проверяйте статусы через backoffice.webhooks.deliveries. Владелец может вызвать backoffice.webhooks.retry с delivery_id: повторяется доставка, а не бизнес-операция. Смена URL отменяет старые неотправленные события, отключение получателя отменяет очередь; уже начатый HTTP-запрос отозвать нельзя. Платформа может приостановить диспетчер — результат настройки содержит dispatcher_enabled.
Каталог операций
Эта справка и OpenAPI собираются из того же реестра, который читает ИИ. Для каждой операции указаны требуемое право и схема входных данных.
Совпадений нет. Попробуйте название сущности или права: menu, inventory, settings.
Заказы
POSTorders.listorders.read · чтение
orders: list
/api/v2/restaurants/{restaurant_id}/operations/orders.list/
Тело запроса:
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Фильтры: period ('today','7d','30d','all'), search (строка поиска), status, low_stock (boolean) и т.д."
},
"limit": {
"type": "integer",
"description": "Лимит записей (по умолчанию 10, максимум 50)",
"minimum": 1,
"maximum": 50
}
},
"required": [],
"additionalProperties": false
}POSTpos_create_orderorders.write · изменяет данные
Открыть чек на кассе: создать заказ на столик со списком блюд. Несколько открытых чеков на одном столе разрешены. Стоп-блюда отклоняются (POS_DISH_STOPPED). Модификаторы (modifiers) пробрасываются в чек, блюдо без групп модификаторов с modifiers отклоняется явно. Аллергия (allergies) блокирует блюдо. Количество >20 — только с confirm_large_quantity=true. На вынос: table='TAKEOUT'.
/api/v2/restaurants/{restaurant_id}/operations/pos_create_order/
Тело запроса:
{
"type": "object",
"properties": {
"table": {
"type": "string",
"description": "Номер стола (например '3', 'VIP-1') или 'TAKEOUT' для заказа на вынос"
},
"items": {
"type": "array",
"description": "Позиции: [{dish: название или ID блюда, quantity: количество 1..20 (больше — только с confirm_large_quantity), modifiers: [{option: название опции} или {group, option}] (опционально)}]",
"items": {
"type": "object"
}
},
"allergies": {
"type": "array",
"description": "Аллергены гостя (например ['milk','nuts']): блюдо с аллергеном блокируется",
"items": {
"type": "string"
}
},
"confirm_large_quantity": {
"type": "boolean",
"description": "Подтверждение количества >20 на позицию (иначе инструмент вернёт requires_confirmation)"
}
},
"required": [
"table",
"items"
],
"additionalProperties": false
}POSTpos_add_itemsorders.write · изменяет данные
Дозаказ в существующий чек: добавить блюда в заказ по ID или номеру чека. Стоп-блюда отклоняются. Закрытые чеки отклоняются. Модификаторы пробрасываются (иначе явный отказ), аллергия блокирует, количество >20 — только с confirm_large_quantity=true.
/api/v2/restaurants/{restaurant_id}/operations/pos_add_items/
Тело запроса:
{
"type": "object",
"properties": {
"order": {
"type": "string",
"description": "ID заказа или номер чека (order_number)"
},
"items": {
"type": "array",
"description": "Позиции: [{dish, quantity 1..20, modifiers?: [{option} или {group, option}]}]",
"items": {
"type": "object"
}
},
"allergies": {
"type": "array",
"description": "Аллергены гостя: блюдо с аллергеном блокируется",
"items": {
"type": "string"
}
},
"confirm_large_quantity": {
"type": "boolean",
"description": "Подтверждение количества >20 на позицию"
}
},
"required": [
"order",
"items"
],
"additionalProperties": false
}POSTpos_kitchen_statusorders.write · изменяет данные
Управление KDS-бордом: двигать заказ по кухонному конвейеру CREATED → ACCEPTED → COOKING → READY → DELIVERED. Только вперёд по цепочке, статусы оплаты/закрытия через этот инструмент недоступны.
/api/v2/restaurants/{restaurant_id}/operations/pos_kitchen_status/
Тело запроса:
{
"type": "object",
"properties": {
"order": {
"type": "string",
"description": "ID заказа или номер чека"
},
"status": {
"type": "string",
"enum": [
"ACCEPTED",
"COOKING",
"READY",
"DELIVERED"
],
"description": "Целевой статус кухни"
}
},
"required": [
"order",
"status"
],
"additionalProperties": false
}Склад
POSTingredients.listinventory.read · чтение
ingredients: list
/api/v2/restaurants/{restaurant_id}/operations/ingredients.list/
Тело запроса:
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Фильтры: period ('today','7d','30d','all'), search (строка поиска), status, low_stock (boolean) и т.д."
},
"limit": {
"type": "integer",
"description": "Лимит записей (по умолчанию 10, максимум 50)",
"minimum": 1,
"maximum": 50
}
},
"required": [],
"additionalProperties": false
}POSTbatches.listinventory.read · чтение
batches: list
/api/v2/restaurants/{restaurant_id}/operations/batches.list/
Тело запроса:
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Фильтры: period ('today','7d','30d','all'), search (строка поиска), status, low_stock (boolean) и т.д."
},
"limit": {
"type": "integer",
"description": "Лимит записей (по умолчанию 10, максимум 50)",
"minimum": 1,
"maximum": 50
}
},
"required": [],
"additionalProperties": false
}POSTingredient.createinventory.write · изменяет данные
ingredient: create
/api/v2/restaurants/{restaurant_id}/operations/ingredient.create/
Тело запроса:
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"unit": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"minimum_quantity": {
"oneOf": [
{
"type": "number",
"minimum": 0,
"maximum": 1000000000000
},
{
"type": "string",
"pattern": "^\\d{1,13}(\\.\\d{1,6})?$"
}
]
},
"quantity": {
"oneOf": [
{
"type": "number",
"minimum": 0,
"maximum": 1000000000000
},
{
"type": "string",
"pattern": "^\\d{1,13}(\\.\\d{1,6})?$"
}
]
},
"price": {
"oneOf": [
{
"type": "number",
"minimum": 0,
"maximum": 1000000000000
},
{
"type": "string",
"pattern": "^\\d{1,13}(\\.\\d{1,6})?$"
}
]
},
"note": {
"type": "string",
"maxLength": 500
}
},
"required": [
"name"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}POSTsupply.createinventory.write · изменяет данные
supply: create
/api/v2/restaurants/{restaurant_id}/operations/supply.create/
Тело запроса:
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"ingredient": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "UUID or exact name in this restaurant."
},
"quantity": {
"oneOf": [
{
"type": "number",
"minimum": 0,
"maximum": 1000000000000
},
{
"type": "string",
"pattern": "^\\d{1,13}(\\.\\d{1,6})?$"
}
]
},
"unit_price": {
"oneOf": [
{
"type": "number",
"minimum": 0,
"maximum": 1000000000000
},
{
"type": "string",
"pattern": "^\\d{1,13}(\\.\\d{1,6})?$"
}
]
},
"note": {
"type": "string",
"maxLength": 500
}
},
"required": [
"ingredient",
"quantity"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}POSTwriteoff.createinventory.write · изменяет данные
writeoff: create
/api/v2/restaurants/{restaurant_id}/operations/writeoff.create/
Тело запроса:
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"ingredient": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "UUID or exact name in this restaurant."
},
"quantity": {
"oneOf": [
{
"type": "number",
"minimum": 0,
"maximum": 1000000000000
},
{
"type": "string",
"pattern": "^\\d{1,13}(\\.\\d{1,6})?$"
}
]
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"note": {
"type": "string",
"maxLength": 500
}
},
"required": [
"ingredient",
"quantity"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}POSTingredient.updateinventory.write · изменяет данные
ingredient: update
/api/v2/restaurants/{restaurant_id}/operations/ingredient.update/
Тело запроса:
{
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "ID, название или номер сущности (например 'Капучино', 'Стол 3', '+998901234567')",
"minLength": 1,
"maxLength": 255
},
"updates": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"unit": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"minimum_quantity": {
"oneOf": [
{
"type": "number",
"minimum": 0,
"maximum": 1000000000000
},
{
"type": "string",
"pattern": "^\\d{1,13}(\\.\\d{1,6})?$"
}
]
}
},
"required": [],
"additionalProperties": false,
"minProperties": 1
}
},
"required": [
"identifier",
"updates"
],
"additionalProperties": false
}POSTingredient.deleteinventory.write · изменяет данные
ingredient: delete
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/ingredient.delete/
Тело запроса:
{
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "Exact UUID of the object in this restaurant.",
"minLength": 1,
"maxLength": 255,
"format": "uuid"
}
},
"required": [
"identifier"
],
"additionalProperties": false
}POSTbackoffice.stock.documents.listinventory.read · чтение
Журнал складских документов
/api/v2/restaurants/{restaurant_id}/operations/backoffice.stock.documents.list/
Тело запроса:
{
"type": "object",
"properties": {
"status": {
"enum": [
"DRAFT",
"POSTED",
"CANCELLED"
]
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 100000
}
},
"required": [],
"additionalProperties": false
}POSTbackoffice.stock.documents.readinventory.read · чтение
Документ и актуальный предпросмотр изменения остатков
/api/v2/restaurants/{restaurant_id}/operations/backoffice.stock.documents.read/
Тело запроса:
{
"type": "object",
"properties": {
"document_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"document_id"
],
"additionalProperties": false
}POSTbackoffice.stock.documents.createinventory.write · изменяет данные
Создать черновик перемещения, инвентаризации или возврата поставщику
/api/v2/restaurants/{restaurant_id}/operations/backoffice.stock.documents.create/
Тело запроса:
{
"type": "object",
"properties": {
"kind": {
"enum": [
"TRANSFER",
"COUNT",
"RETURN"
]
},
"source_storage_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"target_storage_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"supplier_id": {
"type": "integer",
"minimum": 1
},
"lines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ingredient_id": {
"type": "string",
"format": "uuid"
},
"quantity": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 999999999.999
},
{
"type": "string",
"pattern": "^\\d{1,9}(\\.\\d{1,3})?$"
}
]
},
"unit_price": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "string",
"pattern": "^\\d{1,12}(\\.\\d{1,6})?$"
}
]
}
},
"required": [
"ingredient_id",
"quantity"
],
"additionalProperties": false
},
"minItems": 1,
"maxItems": 200
},
"note": {
"type": "string",
"maxLength": 255
}
},
"required": [
"kind",
"lines"
],
"additionalProperties": false
}POSTbackoffice.stock.documents.postinventory.write · изменяет данные
Провести складской документ после проверки предпросмотра
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/backoffice.stock.documents.post/
Тело запроса:
{
"type": "object",
"properties": {
"document_id": {
"type": "string",
"format": "uuid"
},
"expected_fingerprint": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"document_id",
"expected_fingerprint"
],
"additionalProperties": false
}POSTbackoffice.stock.count.updateТолько JWT владельца · изменяет данные
Продолжить черновик инвентаризации с защитой от одновременного редактирования
/api/v2/restaurants/{restaurant_id}/operations/backoffice.stock.count.update/
Тело запроса:
{
"type": "object",
"properties": {
"document_id": {
"type": "string",
"format": "uuid"
},
"expected_revision": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"lines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ingredient_id": {
"type": "string",
"format": "uuid"
},
"quantity": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 999999999.999
},
{
"type": "string",
"pattern": "^\\d{1,9}(\\.\\d{1,3})?$"
}
]
},
"unit_price": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "string",
"pattern": "^\\d{1,12}(\\.\\d{1,6})?$"
}
]
}
},
"required": [
"ingredient_id",
"quantity"
],
"additionalProperties": false
},
"minItems": 1,
"maxItems": 200
},
"note": {
"type": "string",
"maxLength": 255
}
},
"required": [
"document_id",
"expected_revision",
"lines"
],
"additionalProperties": false
}POSTbackoffice.stock.documents.cancelinventory.write · изменяет данные
Отменить непроведённый черновик
/api/v2/restaurants/{restaurant_id}/operations/backoffice.stock.documents.cancel/
Тело запроса:
{
"type": "object",
"properties": {
"document_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"document_id"
],
"additionalProperties": false
}POSTbackoffice.production.listinventory.read · чтение
Журнал складского выпуска полуфабрикатов
/api/v2/restaurants/{restaurant_id}/operations/backoffice.production.list/
Тело запроса:
{
"type": "object",
"properties": {
"status": {
"enum": [
"draft",
"completed",
"cancelled"
]
}
},
"required": [],
"additionalProperties": false
}POSTbackoffice.production.createinventory.write · изменяет данные
Создать черновик выпуска с выходом, количеством партий и складами
/api/v2/restaurants/{restaurant_id}/operations/backoffice.production.create/
Тело запроса:
{
"type": "object",
"properties": {
"tech_card_id": {
"type": "string",
"format": "uuid"
},
"output_qty": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 999999999.999
},
{
"type": "string",
"pattern": "^\\d{1,9}(\\.\\d{1,3})?$"
}
]
},
"measured_input_qty": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 999999999.999
},
{
"type": "string",
"pattern": "^\\d{1,9}(\\.\\d{1,3})?$"
}
]
},
"batch_count": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 100000
},
"source_storage_id": {
"type": "string",
"format": "uuid"
},
"target_storage_id": {
"type": "string",
"format": "uuid"
},
"expires_at": {
"type": "string",
"format": "date"
}
},
"required": [
"tech_card_id",
"output_qty"
],
"additionalProperties": false
}POSTbackoffice.production.readinventory.read · чтение
Посмотреть выпуск, входы, потери и сохранённую стоимость
/api/v2/restaurants/{restaurant_id}/operations/backoffice.production.read/
Тело запроса:
{
"type": "object",
"properties": {
"run_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"run_id"
],
"additionalProperties": false
}POSTbackoffice.production.previewinventory.read · чтение
Проверить сырьё, партии и выход перед проведением производства
/api/v2/restaurants/{restaurant_id}/operations/backoffice.production.preview/
Тело запроса:
{
"type": "object",
"properties": {
"run_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"run_id"
],
"additionalProperties": false
}POSTbackoffice.production.completeinventory.write · изменяет данные
Провести выпуск: списать сырьё и оприходовать полуфабрикат с фактической стоимостью
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/backoffice.production.complete/
Тело запроса:
{
"type": "object",
"properties": {
"run_id": {
"type": "string",
"format": "uuid"
},
"expected_fingerprint": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"run_id",
"expected_fingerprint"
],
"additionalProperties": false
}POSTbackoffice.production.cancelinventory.write · изменяет данные
Отменить непроведённый выпуск
/api/v2/restaurants/{restaurant_id}/operations/backoffice.production.cancel/
Тело запроса:
{
"type": "object",
"properties": {
"run_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"run_id"
],
"additionalProperties": false
}POSTbackoffice.purchases.receipts.previewinventory.read · чтение
Предпросмотр частичной приёмки заказа поставщику
/api/v2/restaurants/{restaurant_id}/operations/backoffice.purchases.receipts.preview/
Тело запроса:
{
"type": "object",
"properties": {
"purchase_order_id": {
"type": "integer",
"minimum": 1
},
"lines": {
"type": "array",
"minItems": 1,
"maxItems": 200,
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"minimum": 1
},
"ingredient_id": {
"type": "string",
"format": "uuid"
},
"quantity": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0,
"maximum": 99999999.99
},
{
"type": "string",
"pattern": "^\\d{1,8}(\\.\\d{1,2})?$"
}
],
"description": "Положительное количество в единицах закупки, не более двух знаков."
},
"unit_price": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 999999999999.99
},
{
"type": "string",
"pattern": "^\\d{1,12}(\\.\\d{1,2})?$"
}
]
},
"storage_id": {
"type": "string",
"format": "uuid"
},
"expires_at": {
"type": "string",
"format": "date"
}
},
"required": [
"item_id",
"ingredient_id",
"quantity"
],
"additionalProperties": false
}
}
},
"required": [
"purchase_order_id",
"lines"
],
"additionalProperties": false
}POSTbackoffice.purchases.receipts.postinventory.write · изменяет данные
Принять товар: остатки, партии, стоимость и факт получения по строкам
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/backoffice.purchases.receipts.post/
Тело запроса:
{
"type": "object",
"properties": {
"purchase_order_id": {
"type": "integer",
"minimum": 1
},
"lines": {
"type": "array",
"minItems": 1,
"maxItems": 200,
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"minimum": 1
},
"ingredient_id": {
"type": "string",
"format": "uuid"
},
"quantity": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0,
"maximum": 99999999.99
},
{
"type": "string",
"pattern": "^\\d{1,8}(\\.\\d{1,2})?$"
}
],
"description": "Положительное количество в единицах закупки, не более двух знаков."
},
"unit_price": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 999999999999.99
},
{
"type": "string",
"pattern": "^\\d{1,12}(\\.\\d{1,2})?$"
}
]
},
"storage_id": {
"type": "string",
"format": "uuid"
},
"expires_at": {
"type": "string",
"format": "date"
}
},
"required": [
"item_id",
"ingredient_id",
"quantity"
],
"additionalProperties": false
}
},
"expected_fingerprint": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"note": {
"type": "string",
"maxLength": 255
}
},
"required": [
"purchase_order_id",
"lines",
"expected_fingerprint"
],
"additionalProperties": false
}POSTbackoffice.purchases.receipts.listinventory.read · чтение
Проведённые частичные приёмки
/api/v2/restaurants/{restaurant_id}/operations/backoffice.purchases.receipts.list/
Тело запроса:
{
"type": "object",
"properties": {
"purchase_order_id": {
"type": "integer",
"minimum": 1
}
},
"required": [],
"additionalProperties": false
}POSTbackoffice.purchases.suppliers.listinventory.read · чтение
Справочник поставщиков выбранного заведения
/api/v2/restaurants/{restaurant_id}/operations/backoffice.purchases.suppliers.list/
Тело запроса:
{
"type": "object",
"properties": {
"offset": {
"type": "integer",
"minimum": 0
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 200
}
},
"required": [],
"additionalProperties": false
}POSTbackoffice.purchases.suppliers.createinventory.write · изменяет данные
Создать поставщика
/api/v2/restaurants/{restaurant_id}/operations/backoffice.purchases.suppliers.create/
Тело запроса:
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"contact_person": {
"type": "string",
"maxLength": 255
},
"phone": {
"type": "string",
"maxLength": 32
},
"email": {
"type": "string",
"maxLength": 254
},
"address": {
"type": "string",
"maxLength": 255
},
"tax_id": {
"type": "string",
"maxLength": 64
},
"payment_terms": {
"type": "string",
"maxLength": 255
},
"notes": {
"type": "string",
"maxLength": 255
},
"is_active": {
"type": "boolean"
}
},
"required": [
"name"
],
"additionalProperties": false
}POSTbackoffice.purchases.suppliers.updateinventory.write · изменяет данные
Изменить или архивировать поставщика
/api/v2/restaurants/{restaurant_id}/operations/backoffice.purchases.suppliers.update/
Тело запроса:
{
"type": "object",
"properties": {
"supplier_id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"contact_person": {
"type": "string",
"maxLength": 255
},
"phone": {
"type": "string",
"maxLength": 32
},
"email": {
"type": "string",
"maxLength": 254
},
"address": {
"type": "string",
"maxLength": 255
},
"tax_id": {
"type": "string",
"maxLength": 64
},
"payment_terms": {
"type": "string",
"maxLength": 255
},
"notes": {
"type": "string",
"maxLength": 255
},
"is_active": {
"type": "boolean"
}
},
"required": [
"supplier_id"
],
"additionalProperties": false
}POSTbackoffice.purchases.products.listinventory.read · чтение
Товары поставщиков и сопоставления со складом
/api/v2/restaurants/{restaurant_id}/operations/backoffice.purchases.products.list/
Тело запроса:
{
"type": "object",
"properties": {
"supplier_id": {
"type": "integer",
"minimum": 1
},
"offset": {
"type": "integer",
"minimum": 0
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 200
}
},
"required": [],
"additionalProperties": false
}POSTbackoffice.purchases.products.createinventory.write · изменяет данные
Создать товар в прайс-листе поставщика
/api/v2/restaurants/{restaurant_id}/operations/backoffice.purchases.products.create/
Тело запроса:
{
"type": "object",
"properties": {
"supplier_id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"unit": {
"type": "string",
"minLength": 1,
"maxLength": 32
},
"price": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 9999999999.99
},
{
"type": "string",
"pattern": "^\\d{1,10}(\\.\\d{1,2})?$"
}
]
},
"min_order_qty": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0,
"maximum": 99999999.99
},
{
"type": "string",
"pattern": "^\\d{1,8}(\\.\\d{1,2})?$"
}
],
"description": "Положительное количество в единицах закупки, не более двух знаков."
},
"delivery_lead_days": {
"type": "integer",
"minimum": 0,
"maximum": 365
},
"is_active": {
"type": "boolean"
}
},
"required": [
"supplier_id",
"name",
"price"
],
"additionalProperties": false
}POSTbackoffice.purchases.products.updateinventory.write · изменяет данные
Обновить товар или закупочную цену поставщика
/api/v2/restaurants/{restaurant_id}/operations/backoffice.purchases.products.update/
Тело запроса:
{
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": 1
},
"supplier_id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"unit": {
"type": "string",
"minLength": 1,
"maxLength": 32
},
"price": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 9999999999.99
},
{
"type": "string",
"pattern": "^\\d{1,10}(\\.\\d{1,2})?$"
}
]
},
"min_order_qty": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0,
"maximum": 99999999.99
},
{
"type": "string",
"pattern": "^\\d{1,8}(\\.\\d{1,2})?$"
}
],
"description": "Положительное количество в единицах закупки, не более двух знаков."
},
"delivery_lead_days": {
"type": "integer",
"minimum": 0,
"maximum": 365
},
"is_active": {
"type": "boolean"
}
},
"required": [
"product_id"
],
"additionalProperties": false
}POSTbackoffice.purchases.products.bindinventory.write · изменяет данные
Связать фасовку товара поставщика со складской единицей ингредиента
/api/v2/restaurants/{restaurant_id}/operations/backoffice.purchases.products.bind/
Тело запроса:
{
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": 1
},
"ingredient_id": {
"type": "string",
"format": "uuid"
},
"stock_quantity_per_purchase_unit": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0,
"maximum": 1000000000000.0
},
{
"type": "string",
"pattern": "^\\d{1,12}(\\.\\d{1,6})?$"
}
]
}
},
"required": [
"product_id",
"ingredient_id",
"stock_quantity_per_purchase_unit"
],
"additionalProperties": false
}POSTbackoffice.purchases.orders.listinventory.read · чтение
Список закупок и их состояние
/api/v2/restaurants/{restaurant_id}/operations/backoffice.purchases.orders.list/
Тело запроса:
{
"type": "object",
"properties": {
"status": {
"enum": [
"DRAFT",
"SENT",
"CONFIRMED",
"SHIPPED",
"RECEIVED",
"CANCELLED"
]
},
"offset": {
"type": "integer",
"minimum": 0
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 200
}
},
"required": [],
"additionalProperties": false
}POSTbackoffice.purchases.orders.readinventory.read · чтение
Строки закупки и уже полученное количество
/api/v2/restaurants/{restaurant_id}/operations/backoffice.purchases.orders.read/
Тело запроса:
{
"type": "object",
"properties": {
"purchase_order_id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"purchase_order_id"
],
"additionalProperties": false
}POSTbackoffice.purchases.orders.createinventory.write · изменяет данные
Создать черновик закупки с фиксированными ценами и фасовкой
/api/v2/restaurants/{restaurant_id}/operations/backoffice.purchases.orders.create/
Тело запроса:
{
"type": "object",
"properties": {
"supplier_id": {
"type": "integer",
"minimum": 1
},
"lines": {
"type": "array",
"minItems": 1,
"maxItems": 200,
"items": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": 1
},
"quantity": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0,
"maximum": 99999999.99
},
{
"type": "string",
"pattern": "^\\d{1,8}(\\.\\d{1,2})?$"
}
],
"description": "Положительное количество в единицах закупки, не более двух знаков."
},
"unit_price": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 9999999999.99
},
{
"type": "string",
"pattern": "^\\d{1,10}(\\.\\d{1,2})?$"
}
]
}
},
"required": [
"product_id",
"quantity"
],
"additionalProperties": false
}
},
"note": {
"type": "string",
"maxLength": 255
},
"expected_date": {
"type": "string",
"format": "date"
}
},
"required": [
"supplier_id",
"lines"
],
"additionalProperties": false
}POSTbackoffice.purchases.orders.approveinventory.write · изменяет данные
Утвердить закупку для приёмки; поставщику сообщения не отправляются
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/backoffice.purchases.orders.approve/
Тело запроса:
{
"type": "object",
"properties": {
"purchase_order_id": {
"type": "integer",
"minimum": 1
},
"expected_fingerprint": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"purchase_order_id"
],
"additionalProperties": false
}POSTbackoffice.purchases.orders.approval.previewinventory.read · чтение
Предпросмотр точного состава и суммы закупки перед утверждением
/api/v2/restaurants/{restaurant_id}/operations/backoffice.purchases.orders.approval.preview/
Тело запроса:
{
"type": "object",
"properties": {
"purchase_order_id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"purchase_order_id"
],
"additionalProperties": false
}POSTbackoffice.purchases.orders.generateinventory.write · изменяет данные
Создать черновики пополнения по минимумам с учётом открытых закупок и фасовок
/api/v2/restaurants/{restaurant_id}/operations/backoffice.purchases.orders.generate/
Тело запроса:
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}POSTbackoffice.purchases.planinventory.read · чтение
План закупки: доступный остаток, сроки годности, открытые заказы и фасовки
/api/v2/restaurants/{restaurant_id}/operations/backoffice.purchases.plan/
Тело запроса:
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}POSTbackoffice.imports.inventory.previewТолько JWT владельца · чтение
Проверить ингредиенты, новые техкарты или начальные остатки из CSV
/api/v2/restaurants/{restaurant_id}/operations/backoffice.imports.inventory.preview/
Тело запроса:
{
"type": "object",
"properties": {
"source": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9_-]{0,63}$"
},
"kind": {
"enum": [
"ingredients",
"recipes",
"opening_stock"
]
},
"csv": {
"type": "string",
"minLength": 1,
"maxLength": 50000
}
},
"required": [
"source",
"kind",
"csv"
],
"additionalProperties": false
}POSTbackoffice.imports.inventory.applyТолько JWT владельца · изменяет данные
Атомарно применить проверенный импорт; повтор файла возвращает прежний результат
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/backoffice.imports.inventory.apply/
Тело запроса:
{
"type": "object",
"properties": {
"source": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9_-]{0,63}$"
},
"kind": {
"enum": [
"ingredients",
"recipes",
"opening_stock"
]
},
"csv": {
"type": "string",
"minLength": 1,
"maxLength": 50000
},
"expected_fingerprint": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"source",
"kind",
"csv",
"expected_fingerprint"
],
"additionalProperties": false
}Зал и столы
POSTtables.listtables.read · чтение
tables: list
/api/v2/restaurants/{restaurant_id}/operations/tables.list/
Тело запроса:
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Фильтры: period ('today','7d','30d','all'), search (строка поиска), status, low_stock (boolean) и т.д."
},
"limit": {
"type": "integer",
"description": "Лимит записей (по умолчанию 10, максимум 50)",
"minimum": 1,
"maximum": 50
}
},
"required": [],
"additionalProperties": false
}POSTtable.createtables.write · изменяет данные
table: create
/api/v2/restaurants/{restaurant_id}/operations/table.create/
Тело запроса:
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"number": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"capacity": {
"type": "integer",
"minimum": 1,
"maximum": 1000
},
"description": {
"type": "string",
"maxLength": 500
},
"shape": {
"enum": [
"SQUARE",
"ROUND",
"RECTANGLE",
"BAR"
]
},
"zone_name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"pos_x": {
"oneOf": [
{
"type": "number",
"minimum": 0,
"maximum": 1000000000000
},
{
"type": "string",
"pattern": "^\\d{1,13}(\\.\\d{1,6})?$"
}
]
},
"pos_y": {
"oneOf": [
{
"type": "number",
"minimum": 0,
"maximum": 1000000000000
},
{
"type": "string",
"pattern": "^\\d{1,13}(\\.\\d{1,6})?$"
}
]
}
},
"required": [
"number"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}POSTtable.updatetables.write · изменяет данные
table: update
/api/v2/restaurants/{restaurant_id}/operations/table.update/
Тело запроса:
{
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "ID, название или номер сущности (например 'Капучино', 'Стол 3', '+998901234567')",
"minLength": 1,
"maxLength": 255
},
"updates": {
"type": "object",
"properties": {
"capacity": {
"type": "integer",
"minimum": 1,
"maximum": 1000
}
},
"required": [],
"additionalProperties": false,
"minProperties": 1
}
},
"required": [
"identifier",
"updates"
],
"additionalProperties": false
}POSTtable.deletetables.write · изменяет данные
table: delete
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/table.delete/
Тело запроса:
{
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "Exact UUID of the object in this restaurant.",
"minLength": 1,
"maxLength": 255,
"format": "uuid"
}
},
"required": [
"identifier"
],
"additionalProperties": false
}Сотрудники
POSTemployees.liststaff.read · чтение
employees: list
/api/v2/restaurants/{restaurant_id}/operations/employees.list/
Тело запроса:
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Фильтры: period ('today','7d','30d','all'), search (строка поиска), status, low_stock (boolean) и т.д."
},
"limit": {
"type": "integer",
"description": "Лимит записей (по умолчанию 10, максимум 50)",
"minimum": 1,
"maximum": 50
}
},
"required": [],
"additionalProperties": false
}POSTshifts.liststaff.read · чтение
shifts: list
/api/v2/restaurants/{restaurant_id}/operations/shifts.list/
Тело запроса:
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Фильтры: period ('today','7d','30d','all'), search (строка поиска), status, low_stock (boolean) и т.д."
},
"limit": {
"type": "integer",
"description": "Лимит записей (по умолчанию 10, максимум 50)",
"minimum": 1,
"maximum": 50
}
},
"required": [],
"additionalProperties": false
}POSTemployee.createstaff.write · изменяет данные
employee: create
/api/v2/restaurants/{restaurant_id}/operations/employee.create/
Тело запроса:
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"full_name": {
"type": "string",
"maxLength": 255
},
"phone_number": {
"type": "string"
},
"role": {
"type": "string",
"enum": [
"MANAGER",
"SHIFT_LEADER",
"WAITER",
"HOSTESS",
"CHEF",
"COOK",
"BARTENDER",
"KITCHEN_MANAGER",
"DISPATCHER",
"COURIER",
"ACCOUNTANT",
"MARKETER",
"ANALYST",
"SUPPORT",
"AUDITOR",
"HEAD_WAITER",
"HEAD_CHEF"
]
},
"pin": {
"type": "string"
}
},
"required": [
"phone_number"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}POSTemployee.updatestaff.write · изменяет данные
employee: update
/api/v2/restaurants/{restaurant_id}/operations/employee.update/
Тело запроса:
{
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "ID, название или номер сущности (например 'Капучино', 'Стол 3', '+998901234567')",
"minLength": 1,
"maxLength": 255
},
"updates": {
"type": "object",
"properties": {
"full_name": {
"type": "string",
"maxLength": 255
},
"role": {
"type": "string",
"enum": [
"MANAGER",
"SHIFT_LEADER",
"WAITER",
"HOSTESS",
"CHEF",
"COOK",
"BARTENDER",
"KITCHEN_MANAGER",
"DISPATCHER",
"COURIER",
"ACCOUNTANT",
"MARKETER",
"ANALYST",
"SUPPORT",
"AUDITOR",
"HEAD_WAITER",
"HEAD_CHEF"
]
},
"pin": {
"type": "string"
}
},
"required": [],
"additionalProperties": false,
"minProperties": 1
}
},
"required": [
"identifier",
"updates"
],
"additionalProperties": false
}POSTemployee.deletestaff.write · изменяет данные
employee: delete
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/employee.delete/
Тело запроса:
{
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "Exact UUID of the object in this restaurant.",
"minLength": 1,
"maxLength": 255,
"format": "uuid"
}
},
"required": [
"identifier"
],
"additionalProperties": false
}POSTbackoffice.payroll.previewТолько JWT владельца · чтение
Рассчитать предпросмотр зарплаты по явкам и перерывам с дневными правилами
/api/v2/restaurants/{restaurant_id}/operations/backoffice.payroll.preview/
Тело запроса:
{
"type": "object",
"properties": {
"period_id": {
"type": "integer",
"minimum": 1
},
"regular_hours_per_day": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 24
},
"overtime_multiplier": {
"type": "number",
"minimum": 1,
"maximum": 5
}
},
"required": [
"period_id"
],
"additionalProperties": false
}POSTbackoffice.payroll.calculateТолько JWT владельца · изменяет данные
Сохранить проверенный расчёт открытого зарплатного периода
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/backoffice.payroll.calculate/
Тело запроса:
{
"type": "object",
"properties": {
"period_id": {
"type": "integer",
"minimum": 1
},
"regular_hours_per_day": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 24
},
"overtime_multiplier": {
"type": "number",
"minimum": 1,
"maximum": 5
},
"expected_fingerprint": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"period_id",
"expected_fingerprint"
],
"additionalProperties": false
}POSTbackoffice.payroll.approval.previewТолько JWT владельца · чтение
Предпросмотр утверждения начислений
/api/v2/restaurants/{restaurant_id}/operations/backoffice.payroll.approval.preview/
Тело запроса:
{
"type": "object",
"properties": {
"period_id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"period_id"
],
"additionalProperties": false
}POSTbackoffice.payroll.approveТолько JWT владельца · изменяет данные
Утвердить и заблокировать начисления
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/backoffice.payroll.approve/
Тело запроса:
{
"type": "object",
"properties": {
"period_id": {
"type": "integer",
"minimum": 1
},
"expected_fingerprint": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"period_id",
"expected_fingerprint"
],
"additionalProperties": false
}POSTbackoffice.payroll.payment.recordТолько JWT владельца · изменяет данные
Зарегистрировать выполненную выплату согласованного периода; перевод не выполняется
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/backoffice.payroll.payment.record/
Тело запроса:
{
"type": "object",
"properties": {
"period_id": {
"type": "integer",
"minimum": 1
},
"reference": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
},
"required": [
"period_id",
"reference"
],
"additionalProperties": false
}POSTbackoffice.staff.rates.listТолько JWT владельца · чтение
Ставки сотрудников отдельно для каждого заведения и даты действия
/api/v2/restaurants/{restaurant_id}/operations/backoffice.staff.rates.list/
Тело запроса:
{
"type": "object",
"properties": {
"user_id": {
"type": "string",
"format": "uuid"
}
},
"required": [],
"additionalProperties": false
}POSTbackoffice.staff.rates.setТолько JWT владельца · изменяет данные
Установить ставку выбранного заведения с даты; согласованная зарплата не меняется
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/backoffice.staff.rates.set/
Тело запроса:
{
"type": "object",
"properties": {
"user_id": {
"type": "string",
"format": "uuid"
},
"effective_from": {
"type": "string",
"format": "date"
},
"hourly_rate": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 999999999999.99
},
{
"type": "string",
"pattern": "^\\d{1,12}(\\.\\d{1,2})?$"
}
]
},
"rate": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 999999999999.99
},
{
"type": "string",
"pattern": "^\\d{1,12}(\\.\\d{1,2})?$"
}
]
},
"pay_type": {
"enum": [
"HOURLY",
"DAILY",
"ORDER"
]
}
},
"required": [
"user_id",
"effective_from"
],
"additionalProperties": false
}POSTbackoffice.payroll.periods.listТолько JWT владельца · чтение
Зарплатные периоды заведения; проверь существующие перед новым расчётом
/api/v2/restaurants/{restaurant_id}/operations/backoffice.payroll.periods.list/
Тело запроса:
{
"type": "object",
"properties": {
"status": {
"enum": [
"OPEN",
"LOCKED",
"PAID"
]
}
},
"required": [],
"additionalProperties": false
}POSTbackoffice.payroll.periods.createТолько JWT владельца · изменяет данные
Создать открытый зарплатный период или вернуть уже существующий с теми же датами
/api/v2/restaurants/{restaurant_id}/operations/backoffice.payroll.periods.create/
Тело запроса:
{
"type": "object",
"properties": {
"start_date": {
"type": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date"
}
},
"required": [
"start_date",
"end_date"
],
"additionalProperties": false
}POSTbackoffice.payroll.entries.readТолько JWT владельца · чтение
Сохранённые начисления и основание расчёта периода
/api/v2/restaurants/{restaurant_id}/operations/backoffice.payroll.entries.read/
Тело запроса:
{
"type": "object",
"properties": {
"period_id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"period_id"
],
"additionalProperties": false
}Кассы, кухня и печать
POSTcashboxes.listdevices.read · чтение
cashboxes: list
/api/v2/restaurants/{restaurant_id}/operations/cashboxes.list/
Тело запроса:
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Фильтры: period ('today','7d','30d','all'), search (строка поиска), status, low_stock (boolean) и т.д."
},
"limit": {
"type": "integer",
"description": "Лимит записей (по умолчанию 10, максимум 50)",
"minimum": 1,
"maximum": 50
}
},
"required": [],
"additionalProperties": false
}POSTkds.listdevices.read · чтение
kds: list
/api/v2/restaurants/{restaurant_id}/operations/kds.list/
Тело запроса:
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Фильтры: period ('today','7d','30d','all'), search (строка поиска), status, low_stock (boolean) и т.д."
},
"limit": {
"type": "integer",
"description": "Лимит записей (по умолчанию 10, максимум 50)",
"minimum": 1,
"maximum": 50
}
},
"required": [],
"additionalProperties": false
}POSTprinters.listdevices.read · чтение
printers: list
/api/v2/restaurants/{restaurant_id}/operations/printers.list/
Тело запроса:
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Фильтры: period ('today','7d','30d','all'), search (строка поиска), status, low_stock (boolean) и т.д."
},
"limit": {
"type": "integer",
"description": "Лимит записей (по умолчанию 10, максимум 50)",
"minimum": 1,
"maximum": 50
}
},
"required": [],
"additionalProperties": false
}POSTcashbox.createdevices.write · изменяет данные
cashbox: create
/api/v2/restaurants/{restaurant_id}/operations/cashbox.create/
Тело запроса:
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"password": {
"type": "string",
"minLength": 8,
"maxLength": 128
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}POSTkds.createdevices.write · изменяет данные
kds: create
/api/v2/restaurants/{restaurant_id}/operations/kds.create/
Тело запроса:
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}POSTcashbox.updatedevices.write · изменяет данные
cashbox: update
/api/v2/restaurants/{restaurant_id}/operations/cashbox.update/
Тело запроса:
{
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "ID, название или номер сущности (например 'Капучино', 'Стол 3', '+998901234567')",
"minLength": 1,
"maxLength": 255
},
"updates": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"new_password": {
"type": "string",
"minLength": 8,
"maxLength": 128
},
"password": {
"const": "regenerate"
}
},
"required": [],
"additionalProperties": false,
"minProperties": 1
}
},
"required": [
"identifier",
"updates"
],
"additionalProperties": false
}POSTprinter.updatedevices.write · изменяет данные
printer: update
/api/v2/restaurants/{restaurant_id}/operations/printer.update/
Тело запроса:
{
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "ID, название или номер сущности (например 'Капучино', 'Стол 3', '+998901234567')",
"minLength": 1,
"maxLength": 255
},
"updates": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"is_active": {
"type": "boolean"
}
},
"required": [],
"additionalProperties": false,
"minProperties": 1
}
},
"required": [
"identifier",
"updates"
],
"additionalProperties": false
}POSTcashbox.deletedevices.write · изменяет данные
cashbox: delete
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/cashbox.delete/
Тело запроса:
{
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "Exact UUID of the object in this restaurant.",
"minLength": 1,
"maxLength": 255,
"format": "uuid"
}
},
"required": [
"identifier"
],
"additionalProperties": false
}POSTdevices.stations.listdevices.read · чтение
Просмотреть станции печати
/api/v2/restaurants/{restaurant_id}/operations/devices.stations.list/
Тело запроса:
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}POSTdevices.stations.createdevices.write · изменяет данные
Создать станцию печати
/api/v2/restaurants/{restaurant_id}/operations/devices.stations.create/
Тело запроса:
{
"type": "object",
"properties": {
"code": {
"type": "string",
"pattern": "^[a-z0-9_-]{1,32}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"is_active": {
"type": "boolean"
},
"is_default": {
"type": "boolean"
}
},
"required": [
"code",
"name"
],
"additionalProperties": false
}POSTdevices.stations.updatedevices.write · изменяет данные
Изменить станцию печати
/api/v2/restaurants/{restaurant_id}/operations/devices.stations.update/
Тело запроса:
{
"type": "object",
"properties": {
"station_id": {
"type": "string",
"format": "uuid"
},
"code": {
"type": "string",
"pattern": "^[a-z0-9_-]{1,32}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"is_active": {
"type": "boolean"
},
"is_default": {
"type": "boolean"
}
},
"required": [
"station_id"
],
"additionalProperties": false
}POSTdevices.stations.deletedevices.write · изменяет данные
Удалить станцию печати
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/devices.stations.delete/
Тело запроса:
{
"type": "object",
"properties": {
"station_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"station_id"
],
"additionalProperties": false
}POSTdevices.printers.listdevices.read · чтение
Просмотреть настройки принтеров
/api/v2/restaurants/{restaurant_id}/operations/devices.printers.list/
Тело запроса:
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}POSTdevices.printers.createdevices.write · изменяет данные
Создать принтер
/api/v2/restaurants/{restaurant_id}/operations/devices.printers.create/
Тело запроса:
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"station_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"connection_type": {
"enum": [
"USB",
"NETWORK"
]
},
"ip_address": {
"type": "string",
"maxLength": 45
},
"port": {
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"serial_path": {
"type": "string",
"maxLength": 256
},
"role": {
"enum": [
"kitchen",
"bar",
"receipt",
"all"
]
},
"copies": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"is_active": {
"type": "boolean"
},
"enabled_job_types": {
"type": "string",
"pattern": "^(|(kitchen|bar|prep|receipt|test)(,(kitchen|bar|prep|receipt|test))*)$"
}
},
"required": [
"name"
],
"additionalProperties": false
}POSTdevices.printers.updatedevices.write · изменяет данные
Изменить принтер
/api/v2/restaurants/{restaurant_id}/operations/devices.printers.update/
Тело запроса:
{
"type": "object",
"properties": {
"printer_id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"station_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"connection_type": {
"enum": [
"USB",
"NETWORK"
]
},
"ip_address": {
"type": "string",
"maxLength": 45
},
"port": {
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"serial_path": {
"type": "string",
"maxLength": 256
},
"role": {
"enum": [
"kitchen",
"bar",
"receipt",
"all"
]
},
"copies": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"is_active": {
"type": "boolean"
},
"enabled_job_types": {
"type": "string",
"pattern": "^(|(kitchen|bar|prep|receipt|test)(,(kitchen|bar|prep|receipt|test))*)$"
}
},
"required": [
"printer_id"
],
"additionalProperties": false
}POSTdevices.printers.deletedevices.write · изменяет данные
Удалить принтер
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/devices.printers.delete/
Тело запроса:
{
"type": "object",
"properties": {
"printer_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"printer_id"
],
"additionalProperties": false
}Отчёты
POSTanalytics.listreports.read · чтение
analytics: list
/api/v2/restaurants/{restaurant_id}/operations/analytics.list/
Тело запроса:
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Фильтры: period ('today','7d','30d','all'), search (строка поиска), status, low_stock (boolean) и т.д."
},
"limit": {
"type": "integer",
"description": "Лимит записей (по умолчанию 10, максимум 50)",
"minimum": 1,
"maximum": 50
}
},
"required": [],
"additionalProperties": false
}POSTdangerous.listreports.read · чтение
dangerous: list
/api/v2/restaurants/{restaurant_id}/operations/dangerous.list/
Тело запроса:
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Фильтры: period ('today','7d','30d','all'), search (строка поиска), status, low_stock (boolean) и т.д."
},
"limit": {
"type": "integer",
"description": "Лимит записей (по умолчанию 10, максимум 50)",
"minimum": 1,
"maximum": 50
}
},
"required": [],
"additionalProperties": false
}POSTpnl.listreports.read · чтение
pnl: list
/api/v2/restaurants/{restaurant_id}/operations/pnl.list/
Тело запроса:
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Фильтры: period ('today','7d','30d','all'), search (строка поиска), status, low_stock (boolean) и т.д."
},
"limit": {
"type": "integer",
"description": "Лимит записей (по умолчанию 10, максимум 50)",
"minimum": 1,
"maximum": 50
}
},
"required": [],
"additionalProperties": false
}POSTbackoffice.reports.marginreports.read · чтение
Маржа по исторической себестоимости; неполные данные явно помечены
/api/v2/restaurants/{restaurant_id}/operations/backoffice.reports.margin/
Тело запроса:
{
"type": "object",
"properties": {
"date_from": {
"type": "string",
"format": "date"
},
"date_to": {
"type": "string",
"format": "date"
}
},
"required": [
"date_from",
"date_to"
],
"additionalProperties": false
}POSTbackoffice.finance.pnlТолько JWT владельца · чтение
P&L: закрытые продажи, возвраты, историческая себестоимость, согласованная зарплата и расходы
/api/v2/restaurants/{restaurant_id}/operations/backoffice.finance.pnl/
Тело запроса:
{
"type": "object",
"properties": {
"date_from": {
"type": "string",
"format": "date"
},
"date_to": {
"type": "string",
"format": "date"
}
},
"required": [
"date_from",
"date_to"
],
"additionalProperties": false
}Бронирования
POSTbookings.listbookings.read · чтение
bookings: list
/api/v2/restaurants/{restaurant_id}/operations/bookings.list/
Тело запроса:
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Фильтры: period ('today','7d','30d','all'), search (строка поиска), status, low_stock (boolean) и т.д."
},
"limit": {
"type": "integer",
"description": "Лимит записей (по умолчанию 10, максимум 50)",
"minimum": 1,
"maximum": 50
}
},
"required": [],
"additionalProperties": false
}POSTbooking.createbookings.write · изменяет данные
booking: create
/api/v2/restaurants/{restaurant_id}/operations/booking.create/
Тело запроса:
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"table": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "UUID or exact name in this restaurant."
},
"booking_date": {
"type": "string",
"format": "date"
},
"booking_time": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
},
"guest_count": {
"type": "integer",
"minimum": 1,
"maximum": 1000
},
"client_name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"client_phone": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"notes": {
"type": "string",
"maxLength": 500
},
"occasion": {
"type": "string",
"maxLength": 500
}
},
"required": [
"table",
"booking_date",
"booking_time",
"guest_count",
"client_name",
"client_phone"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}POSTbooking.updatebookings.write · изменяет данные
booking: update
/api/v2/restaurants/{restaurant_id}/operations/booking.update/
Тело запроса:
{
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "ID, название или номер сущности (например 'Капучино', 'Стол 3', '+998901234567')",
"minLength": 1,
"maxLength": 255
},
"updates": {
"type": "object",
"description": "Поля для изменения в JSON (price, stock, pin, seats, name, is_active и др.)"
}
},
"required": [
"identifier",
"updates"
],
"additionalProperties": false
}POSTbooking.deletebookings.write · изменяет данные
booking: delete
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/booking.delete/
Тело запроса:
{
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "Exact UUID of the object in this restaurant.",
"minLength": 1,
"maxLength": 255,
"format": "uuid"
}
},
"required": [
"identifier"
],
"additionalProperties": false
}POSTbooking_scenario_viewbookings.read · чтение
Показать сценарий бота броней: шаги напоминания/no-show/follow-up с текстами, таймингами и вкл/выкл. Без аргументов.
/api/v2/restaurants/{restaurant_id}/operations/booking_scenario_view/
Тело запроса:
{
"type": "object",
"properties": {},
"additionalProperties": false
}POSTbooking_scenario_setbookings.write · изменяет данные
Настроить сценарий бота броней словами владельца: поменять текст шага, вкл/выкл шаг, поменять тайминги (remind_minutes — за сколько напоминать, noshow_minutes — через сколько отменять неявку, followup_minutes — через сколько писать после неявки). Кнопки гостя: Приду / Я в пути / Опоздаю на 15 / Отменить, свободный текст гостя не обрабатывается.
/api/v2/restaurants/{restaurant_id}/operations/booking_scenario_set/
Тело запроса:
{
"type": "object",
"properties": {
"step": {
"type": "string",
"enum": [
"reminder",
"noshow",
"late_hold",
"table_ready",
"running_late_ask",
"followup_1h",
"followup_24h"
],
"description": "Какой шаг правим"
},
"text": {
"type": "string",
"description": "Новый текст шага. Плейсхолдеры: {name} {restaurant} {date} {time} {guests} {table}"
},
"enabled": {
"type": "boolean",
"description": "Включить/выключить шаг"
},
"remind_minutes": {
"type": "number",
"description": "За сколько минут до брони напоминать (1..120)"
},
"noshow_minutes": {
"type": "number",
"description": "Через сколько минут неявки отменять бронь (1..120)"
},
"followup_minutes": {
"type": "number",
"description": "Через сколько минут после неявки слать follow-up (для followup-шагов)"
}
},
"additionalProperties": false
}POSTbooking_statsbookings.read · чтение
Статистика броней и бота: сколько подтвердилось/отменено/не пришло, сколько напоминаний отправлено и сколько гостей нажали «Приду». Без аргументов (последние 30 дней).
/api/v2/restaurants/{restaurant_id}/operations/booking_stats/
Тело запроса:
{
"type": "object",
"properties": {},
"additionalProperties": false
}Маркетинг
POSTpromos.listmarketing.read · чтение
promos: list
/api/v2/restaurants/{restaurant_id}/operations/promos.list/
Тело запроса:
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Фильтры: period ('today','7d','30d','all'), search (строка поиска), status, low_stock (boolean) и т.д."
},
"limit": {
"type": "integer",
"description": "Лимит записей (по умолчанию 10, максимум 50)",
"minimum": 1,
"maximum": 50
}
},
"required": [],
"additionalProperties": false
}POSTcampaigns.listmarketing.read · чтение
campaigns: list
/api/v2/restaurants/{restaurant_id}/operations/campaigns.list/
Тело запроса:
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Фильтры: period ('today','7d','30d','all'), search (строка поиска), status, low_stock (boolean) и т.д."
},
"limit": {
"type": "integer",
"description": "Лимит записей (по умолчанию 10, максимум 50)",
"minimum": 1,
"maximum": 50
}
},
"required": [],
"additionalProperties": false
}POSTpromo.createmarketing.write · изменяет данные
promo: create
/api/v2/restaurants/{restaurant_id}/operations/promo.create/
Тело запроса:
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"code": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"discount_type": {
"enum": [
"PERCENT",
"FIXED"
]
},
"discount_value": {
"oneOf": [
{
"type": "number",
"minimum": 0,
"maximum": 99999999.99
},
{
"type": "string",
"pattern": "^\\d{1,8}(\\.\\d{1,2})?$"
}
],
"description": "Неотрицательная сумма, максимум 99999999.99, не более двух знаков после точки."
},
"min_order_amount": {
"oneOf": [
{
"type": "number",
"minimum": 0,
"maximum": 99999999.99
},
{
"type": "string",
"pattern": "^\\d{1,8}(\\.\\d{1,2})?$"
}
],
"description": "Неотрицательная сумма, максимум 99999999.99, не более двух знаков после точки."
},
"max_uses": {
"type": "integer",
"minimum": 0
},
"max_uses_per_guest": {
"type": "integer",
"minimum": 0
}
},
"required": [
"code",
"discount_value"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}POSTcampaign.createmarketing.write · изменяет данные
campaign: create
/api/v2/restaurants/{restaurant_id}/operations/campaign.create/
Тело запроса:
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"kind": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"rules": {
"type": "object"
}
},
"required": [
"name",
"kind"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}Настройки и оформление
POSTmenu_settings.listsettings.read · чтение
menu_settings: list
/api/v2/restaurants/{restaurant_id}/operations/menu_settings.list/
Тело запроса:
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Фильтры: period ('today','7d','30d','all'), search (строка поиска), status, low_stock (boolean) и т.д."
},
"limit": {
"type": "integer",
"description": "Лимит записей (по умолчанию 10, максимум 50)",
"minimum": 1,
"maximum": 50
}
},
"required": [],
"additionalProperties": false
}POSTbranding.listsettings.read · чтение
branding: list
/api/v2/restaurants/{restaurant_id}/operations/branding.list/
Тело запроса:
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Фильтры: period ('today','7d','30d','all'), search (строка поиска), status, low_stock (boolean) и т.д."
},
"limit": {
"type": "integer",
"description": "Лимит записей (по умолчанию 10, максимум 50)",
"minimum": 1,
"maximum": 50
}
},
"required": [],
"additionalProperties": false
}POSTpos_theme.updatesettings.write · изменяет данные
pos_theme: update
/api/v2/restaurants/{restaurant_id}/operations/pos_theme.update/
Тело запроса:
{
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "ID, название или номер сущности (например 'Капучино', 'Стол 3', '+998901234567')",
"minLength": 1,
"maxLength": 255
},
"updates": {
"type": "object",
"properties": {
"accent_color": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"welcome_title": {
"type": "string",
"maxLength": 80
}
},
"required": [],
"additionalProperties": false,
"minProperties": 1
}
},
"required": [
"identifier",
"updates"
],
"additionalProperties": false
}POSTpos_layout.updatesettings.write · изменяет данные
pos_layout: update
/api/v2/restaurants/{restaurant_id}/operations/pos_layout.update/
Тело запроса:
{
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "ID, название или номер сущности (например 'Капучино', 'Стол 3', '+998901234567')",
"minLength": 1,
"maxLength": 255
},
"updates": {
"type": "object",
"description": "Поля для изменения в JSON (price, stock, pin, seats, name, is_active и др.)"
}
},
"required": [
"identifier",
"updates"
],
"additionalProperties": false
}POSTdashboard.updatesettings.write · изменяет данные
dashboard: update
/api/v2/restaurants/{restaurant_id}/operations/dashboard.update/
Тело запроса:
{
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "ID, название или номер сущности (например 'Капучино', 'Стол 3', '+998901234567')",
"minLength": 1,
"maxLength": 255
},
"updates": {
"type": "object",
"description": "Поля для изменения в JSON (price, stock, pin, seats, name, is_active и др.)"
}
},
"required": [
"identifier",
"updates"
],
"additionalProperties": false
}POSTmenu_settings.updatesettings.write · изменяет данные
menu_settings: update
/api/v2/restaurants/{restaurant_id}/operations/menu_settings.update/
Тело запроса:
{
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "ID, название или номер сущности (например 'Капучино', 'Стол 3', '+998901234567')",
"minLength": 1,
"maxLength": 255
},
"updates": {
"type": "object",
"description": "Поля для изменения в JSON (price, stock, pin, seats, name, is_active и др.)"
}
},
"required": [
"identifier",
"updates"
],
"additionalProperties": false
}POSTbranding.updatesettings.write · изменяет данные
branding: update
/api/v2/restaurants/{restaurant_id}/operations/branding.update/
Тело запроса:
{
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "ID, название или номер сущности (например 'Капучино', 'Стол 3', '+998901234567')",
"minLength": 1,
"maxLength": 255
},
"updates": {
"type": "object",
"description": "Поля для изменения в JSON (price, stock, pin, seats, name, is_active и др.)"
}
},
"required": [
"identifier",
"updates"
],
"additionalProperties": false
}POSTsettings.profile.readsettings.read · чтение
Настройки profile: read
/api/v2/restaurants/{restaurant_id}/operations/settings.profile.read/
Тело запроса:
{
"type": "object",
"properties": {},
"additionalProperties": false
}POSTsettings.profile.updatesettings.write · изменяет данные
Настройки profile: update
/api/v2/restaurants/{restaurant_id}/operations/settings.profile.update/
Тело запроса:
{
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 255
},
"address": {
"type": "string",
"maxLength": 255
},
"phone": {
"type": "string",
"maxLength": 30
},
"inn": {
"type": "string",
"maxLength": 64
},
"receipt_footer": {
"type": "string",
"maxLength": 255
},
"service_charge_percent": {
"type": "string",
"pattern": "^\\d{1,3}(\\.\\d{1,2})?$",
"description": "Decimal percent, 0–100."
},
"nds_percent": {
"type": "string",
"pattern": "^\\d{1,3}(\\.\\d{1,2})?$",
"description": "Decimal percent, 0–100."
},
"waiter_commission_percent": {
"type": "string",
"pattern": "^\\d{1,3}(\\.\\d{1,2})?$",
"description": "Decimal percent, 0–100."
},
"rights": {
"type": "object",
"properties": {
"manager_can_write_off_stock": {
"type": "boolean"
},
"chef_can_write_off_stock": {
"type": "boolean"
},
"cook_can_view_recipes": {
"type": "boolean"
},
"allow_void_without_manager": {
"type": "boolean"
},
"allow_refund_without_manager": {
"type": "boolean"
},
"max_discount_percent": {
"type": "integer",
"minimum": 0,
"maximum": 100
}
},
"required": [],
"additionalProperties": false
},
"working_hours": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"open": {
"type": "string"
},
"close": {
"type": "string"
}
},
"required": [
"enabled",
"open",
"close"
],
"additionalProperties": false
}
},
"tg_reports_enabled": {
"type": "boolean"
},
"tg_report_interval_hours": {
"type": "integer",
"minimum": 1,
"maximum": 24
},
"notify_prefs": {
"type": "object",
"properties": {
"revenue": {
"type": "boolean"
},
"voids": {
"type": "boolean"
},
"low_stock": {
"type": "boolean"
},
"bookings": {
"type": "boolean"
},
"shifts": {
"type": "boolean"
},
"reviews": {
"type": "boolean"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
}POSTsettings.pos.readsettings.read · чтение
Настройки pos: read
/api/v2/restaurants/{restaurant_id}/operations/settings.pos.read/
Тело запроса:
{
"type": "object",
"properties": {},
"additionalProperties": false
}POSTsettings.pos.updatesettings.write · изменяет данные
Настройки pos: update
/api/v2/restaurants/{restaurant_id}/operations/settings.pos.update/
Тело запроса:
{
"type": "object",
"properties": {
"pos_pin_required": {
"type": "boolean"
},
"booking_remind_minutes": {
"type": "integer",
"minimum": 1,
"maximum": 120
},
"booking_noshow_minutes": {
"type": "integer",
"minimum": 1,
"maximum": 120
},
"booking_deposit_enabled": {
"type": "boolean"
},
"booking_deposit_amount": {
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"booking_free_cancel_hours": {
"type": "integer",
"minimum": 0,
"maximum": 72
}
},
"required": [],
"additionalProperties": false
}POSTsettings.ai.readsettings.read · чтение
Настройки ai: read
/api/v2/restaurants/{restaurant_id}/operations/settings.ai.read/
Тело запроса:
{
"type": "object",
"properties": {},
"additionalProperties": false
}POSTsettings.ai.updatesettings.write · изменяет данные
Настройки ai: update
/api/v2/restaurants/{restaurant_id}/operations/settings.ai.update/
Тело запроса:
{
"type": "object",
"properties": {
"ai_enabled": {
"type": "boolean"
},
"ai_owner_enabled": {
"type": "boolean"
},
"ai_kassa_enabled": {
"type": "boolean"
},
"ai_kitchen_enabled": {
"type": "boolean"
}
},
"required": [],
"additionalProperties": false
}POSTbackoffice.readinessТолько JWT владельца · чтение
Проверить готовность учёта, фискального провайдера и принтеров
/api/v2/restaurants/{restaurant_id}/operations/backoffice.readiness/
Тело запроса:
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}Доставка
POSTdelivery_zones.listdelivery.read · чтение
delivery_zones: list
/api/v2/restaurants/{restaurant_id}/operations/delivery_zones.list/
Тело запроса:
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Фильтры: period ('today','7d','30d','all'), search (строка поиска), status, low_stock (boolean) и т.д."
},
"limit": {
"type": "integer",
"description": "Лимит записей (по умолчанию 10, максимум 50)",
"minimum": 1,
"maximum": 50
}
},
"required": [],
"additionalProperties": false
}POSTcouriers.listdelivery.read · чтение
couriers: list
/api/v2/restaurants/{restaurant_id}/operations/couriers.list/
Тело запроса:
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Фильтры: period ('today','7d','30d','all'), search (строка поиска), status, low_stock (boolean) и т.д."
},
"limit": {
"type": "integer",
"description": "Лимит записей (по умолчанию 10, максимум 50)",
"minimum": 1,
"maximum": 50
}
},
"required": [],
"additionalProperties": false
}POSTdelivery_zone.createdelivery.write · изменяет данные
delivery_zone: create
/api/v2/restaurants/{restaurant_id}/operations/delivery_zone.create/
Тело запроса:
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"delivery_fee": {
"oneOf": [
{
"type": "number",
"minimum": 0,
"maximum": 1000000000000
},
{
"type": "string",
"pattern": "^\\d{1,13}(\\.\\d{1,6})?$"
}
]
},
"min_order_amount": {
"oneOf": [
{
"type": "number",
"minimum": 0,
"maximum": 1000000000000
},
{
"type": "string",
"pattern": "^\\d{1,13}(\\.\\d{1,6})?$"
}
]
}
},
"required": [
"name"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}POSTcourier.createdelivery.write · изменяет данные
courier: create
/api/v2/restaurants/{restaurant_id}/operations/courier.create/
Тело запроса:
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"phone": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"required": [
"name"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}Депозиты
POSTdeposits.listpayments.read · чтение
deposits: list
/api/v2/restaurants/{restaurant_id}/operations/deposits.list/
Тело запроса:
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Фильтры: period ('today','7d','30d','all'), search (строка поиска), status, low_stock (boolean) и т.д."
},
"limit": {
"type": "integer",
"description": "Лимит записей (по умолчанию 10, максимум 50)",
"minimum": 1,
"maximum": 50
}
},
"required": [],
"additionalProperties": false
}POSTdeposit.createpayments.write · изменяет данные
deposit: create
/api/v2/restaurants/{restaurant_id}/operations/deposit.create/
Тело запроса:
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"guest": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "UUID or exact name in this restaurant."
},
"amount": {
"oneOf": [
{
"type": "number",
"minimum": 0,
"maximum": 1000000000000
},
{
"type": "string",
"pattern": "^\\d{1,13}(\\.\\d{1,6})?$"
}
]
},
"note": {
"type": "string",
"maxLength": 500
}
},
"required": [
"guest",
"amount"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}POSTbackoffice.payments.reconciliationТолько JWT владельца · чтение
Разделить сохранённые статусы платежа, сверки и фискального чека; без запросов провайдеру
/api/v2/restaurants/{restaurant_id}/operations/backoffice.payments.reconciliation/
Тело запроса:
{
"type": "object",
"properties": {
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"status": {
"enum": [
"PENDING",
"PAID",
"FAILED",
"CANCELLED",
"REFUNDED"
]
}
},
"required": [],
"additionalProperties": false
}POSTbackoffice.payments.bundle.previewТолько JWT владельца · чтение
Предварительный расчёт нескольких чеков одного стола без списания и резервирования
/api/v2/restaurants/{restaurant_id}/operations/backoffice.payments.bundle.preview/
Тело запроса:
{
"type": "object",
"properties": {
"order_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"maxItems": 20,
"uniqueItems": true
}
},
"required": [
"order_ids"
],
"additionalProperties": false
}POSTbackoffice.suppliers.balanceТолько JWT владельца · чтение
Расчёты по проведённым приёмкам; непарные накладные показаны отдельно
/api/v2/restaurants/{restaurant_id}/operations/backoffice.suppliers.balance/
Тело запроса:
{
"type": "object",
"properties": {
"supplier_id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"supplier_id"
],
"additionalProperties": false
}POSTbackoffice.suppliers.payment.recordТолько JWT владельца · изменяет данные
Зарегистрировать уже выполненный платёж поставщику; перевод не выполняется
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/backoffice.suppliers.payment.record/
Тело запроса:
{
"type": "object",
"properties": {
"supplier_id": {
"type": "integer",
"minimum": 1
},
"amount": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 999999999999.99
},
{
"type": "string",
"pattern": "^\\d{1,12}(\\.\\d{1,2})?$"
}
]
},
"method": {
"enum": [
"CASH",
"BANK"
]
},
"reference": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"note": {
"type": "string",
"maxLength": 255
},
"paid_at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"supplier_id",
"amount",
"method",
"reference"
],
"additionalProperties": false
}POSTbackoffice.cash.shifts.listТолько JWT владельца · чтение
Кассовые смены выбранного заведения
/api/v2/restaurants/{restaurant_id}/operations/backoffice.cash.shifts.list/
Тело запроса:
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}POSTbackoffice.cash.shifts.previewТолько JWT владельца · чтение
Предпросмотр сверки выбранной кассовой смены
/api/v2/restaurants/{restaurant_id}/operations/backoffice.cash.shifts.preview/
Тело запроса:
{
"type": "object",
"properties": {
"shift_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"shift_id"
],
"additionalProperties": false
}POSTbackoffice.cash.shifts.closeТолько JWT владельца · изменяет данные
Закрыть смену с фактическим пересчётом и зафиксировать отчёт
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/backoffice.cash.shifts.close/
Тело запроса:
{
"type": "object",
"properties": {
"shift_id": {
"type": "string",
"format": "uuid"
},
"actual_cash": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 999999999999.99
},
{
"type": "string",
"pattern": "^\\d{1,12}(\\.\\d{1,2})?$"
}
]
},
"expected_fingerprint": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"shift_id",
"actual_cash",
"expected_fingerprint"
],
"additionalProperties": false
}POSTbackoffice.finance.expenses.listТолько JWT владельца · чтение
Журнал операционных расходов с сохранением отменённых записей
/api/v2/restaurants/{restaurant_id}/operations/backoffice.finance.expenses.list/
Тело запроса:
{
"type": "object",
"properties": {
"date_from": {
"type": "string",
"format": "date"
},
"date_to": {
"type": "string",
"format": "date"
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 100000
}
},
"required": [
"date_from",
"date_to"
],
"additionalProperties": false
}POSTbackoffice.finance.expenses.createТолько JWT владельца · изменяет данные
Записать начисленный расход P&L; деньги не переводятся
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/backoffice.finance.expenses.create/
Тело запроса:
{
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date"
},
"category": {
"enum": [
"rent",
"transport",
"utilities",
"marketing",
"equipment",
"bank_fees",
"tax",
"other"
]
},
"amount": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 999999999999.99
},
{
"type": "string",
"pattern": "^\\d{1,12}(\\.\\d{1,2})?$"
}
]
},
"description": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"required": [
"date",
"category",
"amount",
"description"
],
"additionalProperties": false
}POSTbackoffice.finance.expenses.voidТолько JWT владельца · изменяет данные
Сторнировать ошибочный расход, сохранив запись в журнале
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/backoffice.finance.expenses.void/
Тело запроса:
{
"type": "object",
"properties": {
"expense_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"expense_id"
],
"additionalProperties": false
}Приложения и свои данные
POSTarch_statuscustomization.read · чтение
Карта архитектуры заведения (только чтение): какие плагины маркетплейса установлены и включены, сколько активных комбо-наборов и промо-акций, какие фичи-флаги включены, сколько касс и столов. Вызывай первым, когда владелец просит что-то включить/настроить/проверить в системе.
/api/v2/restaurants/{restaurant_id}/operations/arch_status/
Тело запроса:
{
"type": "object",
"properties": {
"section": {
"type": "string",
"enum": [
"overview",
"plugins",
"combos",
"flags"
],
"description": "overview (всё коротко), plugins (модули), combos (наборы), flags (фичи-флаги)"
}
},
"required": [],
"additionalProperties": false
}POSTarch_installcustomization.write · изменяет данные
Установить плагин маркетплейса в заведение и включить (не удаляет ничего — выполняется сразу).
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/arch_install/
Тело запроса:
{
"type": "object",
"properties": {
"slug": {
"type": "string",
"description": "Слаг модуля, напр. combo-lunch"
}
},
"required": [
"slug"
],
"additionalProperties": false
}POSTarch_togglecustomization.write · изменяет данные
Включить плагин — сразу. ВЫКЛЮЧИТЬ — только через кнопку «Подтвердить» владельца (выключение останавливает скидки/механики).
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/arch_toggle/
Тело запроса:
{
"type": "object",
"properties": {
"slug": {
"type": "string",
"description": "Слаг модуля"
},
"enabled": {
"type": "boolean",
"description": "true — включить, false — выключить (потребует подтверждения)"
}
},
"required": [
"slug",
"enabled"
],
"additionalProperties": false
}POSTarch_uninstallcustomization.write · изменяет данные
Снять плагин с заведения — НЕ выполняется сразу, только через кнопку «Подтвердить» владельца.
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/arch_uninstall/
Тело запроса:
{
"type": "object",
"properties": {
"slug": {
"type": "string",
"description": "Слаг модуля"
}
},
"required": [
"slug"
],
"additionalProperties": false
}POSTarch_actcustomization.write · изменяет данные
Действие плагина. Чтение (status/preview/dry_run) — сразу. Создание (напр. комбо) — сразу. Удаление/отключение (delete/remove/uninstall, toggle в false) — только через кнопку «Подтвердить» владельца. Сам НИКОГДА ничего не удаляй в обход.
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/arch_act/
Тело запроса:
{
"type": "object",
"properties": {
"slug": {
"type": "string",
"description": "Слаг модуля, напр. combo-lunch"
},
"action": {
"type": "string",
"description": "Действие, напр. preview/create/toggle/delete"
},
"data": {
"type": "object",
"description": "Параметры действия в JSON"
}
},
"required": [
"slug",
"action"
],
"additionalProperties": false
}POSTcreate_appcustomization.write · изменяет данные
Создать приложение для заведения по описанию владельца. Используй каталог из 25 шаблонов Marketplace-страниц; для приложения с несколькими рабочими сценариями можно собрать 2–5 разных страниц. Waitly даёт общий AppShell и Sidebar, а страницы приложения добавляются в sidebar-группу. Черновик появляется в «Моих приложениях»; после создания предложи опубликовать или установить.
/api/v2/restaurants/{restaurant_id}/operations/create_app/
Тело запроса:
{
"type": "object",
"properties": {
"prompt": {
"type": "string",
"description": "Что должно делать приложение, одним-двумя предложениями"
}
},
"required": [
"prompt"
],
"additionalProperties": false
}POSTlist_appscustomization.read · чтение
Показать каталог приложений маркетплейса (публичные + свои).
/api/v2/restaurants/{restaurant_id}/operations/list_apps/
Тело запроса:
{
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "Поиск по названию (необязательно)"
}
},
"required": [],
"additionalProperties": false
}POSTpublish_appcustomization.write · изменяет данные
Опубликовать своё приложение в маркетплейс, чтобы его видели другие заведения. Обложка-шаблон сгенерится сама, если автор не залил свою.
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/publish_app/
Тело запроса:
{
"type": "object",
"properties": {
"slug": {
"type": "string",
"description": "Slug приложения"
}
},
"required": [
"slug"
],
"additionalProperties": false
}POSTinstall_appcustomization.write · изменяет данные
Установить приложение из маркетплейса в своё заведение. Установленное появляется в «Моих приложениях».
/api/v2/restaurants/{restaurant_id}/operations/install_app/
Тело запроса:
{
"type": "object",
"properties": {
"slug": {
"type": "string",
"description": "Slug приложения из каталога"
}
},
"required": [
"slug"
],
"additionalProperties": false
}POSTpos_page_createcustomization.write · изменяет данные
Создать кастомный экран КАССЫ (PWA) по описанию владельца («экран банкетов», «учёт поломок на кассе»). Создаётся черновиком (DRAFT) — на кассе его ещё нет. После создания предложи опубликовать через pos_page_publish.
/api/v2/restaurants/{restaurant_id}/operations/pos_page_create/
Тело запроса:
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Название экрана (до 128 символов)"
},
"brief": {
"type": "string",
"description": "Что на экране: какие блоки и данные (1-3 предложения)"
}
},
"required": [
"title",
"brief"
],
"additionalProperties": false
}POSTpos_page_publishcustomization.write · изменяет данные
Опубликовать/снять с публикации кастомный экран кассы. Опубликованный экран СРАЗУ появляется в PWA (раздел «Мои экраны», без пересборки). Вызывай только на прямое «опубликуй/покажи на кассе» владельца.
/api/v2/restaurants/{restaurant_id}/operations/pos_page_publish/
Тело запроса:
{
"type": "object",
"properties": {
"page": {
"type": "string",
"description": "Slug или id страницы"
},
"publish": {
"type": "boolean",
"description": "true — опубликовать, false — снять с кассы (по умолчанию true)"
}
},
"required": [
"page"
],
"additionalProperties": false
}POSTpos_pages_listcustomization.read · чтение
Показать кастомные экраны кассы заведения: черновики и опубликованные (что уже видно на кассе).
/api/v2/restaurants/{restaurant_id}/operations/pos_pages_list/
Тело запроса:
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}POSTrecords.listcustomization.read · чтение
Пользовательские данные: list
/api/v2/restaurants/{restaurant_id}/operations/records.list/
Тело запроса:
{
"type": "object",
"properties": {
"slug": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,64}$"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 100000
}
},
"required": [
"slug"
],
"additionalProperties": false
}POSTrecords.createcustomization.write · изменяет данные
Пользовательские данные: create
/api/v2/restaurants/{restaurant_id}/operations/records.create/
Тело запроса:
{
"type": "object",
"properties": {
"slug": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,64}$"
},
"data": {
"type": "object",
"description": "Пользовательские поля записи. Не меняют системные модели Waitly."
}
},
"required": [
"slug",
"data"
],
"additionalProperties": false
}POSTrecords.updatecustomization.write · изменяет данные
Пользовательские данные: update
/api/v2/restaurants/{restaurant_id}/operations/records.update/
Тело запроса:
{
"type": "object",
"properties": {
"slug": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,64}$"
},
"record_id": {
"type": "string",
"format": "uuid"
},
"data": {
"type": "object",
"description": "Пользовательские поля записи. Не меняют системные модели Waitly."
}
},
"required": [
"slug",
"record_id",
"data"
],
"additionalProperties": false
}POSTrecords.deletecustomization.write · изменяет данные
Пользовательские данные: delete
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/records.delete/
Тело запроса:
{
"type": "object",
"properties": {
"slug": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,64}$"
},
"record_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"slug",
"record_id"
],
"additionalProperties": false
}Доступ и права
POSTaccess.templatesТолько JWT владельца · чтение
Роли и матрица прав доступа
/api/v2/restaurants/{restaurant_id}/operations/access.templates/
Тело запроса:
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}POSTaccess.grants.listТолько JWT владельца · чтение
Просмотреть предоставленный доступ
/api/v2/restaurants/{restaurant_id}/operations/access.grants.list/
Тело запроса:
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}POSTaccess.grants.createТолько JWT владельца · изменяет данные
Предоставить доступ к заведению
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/access.grants.create/
Тело запроса:
{
"type": "object",
"properties": {
"phone": {
"type": "string",
"maxLength": 32
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"role": {
"enum": [
"INVESTOR",
"MANAGER",
"ACCOUNTANT",
"ANALYST",
"AUDITOR"
]
},
"scopes": {
"type": "object",
"properties": {
"stats": {
"enum": [
"none",
"view",
"manage"
]
},
"finance": {
"enum": [
"none",
"view",
"manage"
]
},
"menu": {
"enum": [
"none",
"view",
"manage"
]
},
"warehouse": {
"enum": [
"none",
"view",
"manage"
]
},
"marketing": {
"enum": [
"none",
"view",
"manage"
]
},
"access": {
"enum": [
"none",
"view",
"manage"
]
}
},
"required": [],
"additionalProperties": false
},
"expires_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"phone"
],
"additionalProperties": false
}POSTaccess.grants.updateТолько JWT владельца · изменяет данные
Изменить права предоставленного доступа
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/access.grants.update/
Тело запроса:
{
"type": "object",
"properties": {
"grant_id": {
"type": "string",
"format": "uuid"
},
"role": {
"enum": [
"INVESTOR",
"MANAGER",
"ACCOUNTANT",
"ANALYST",
"AUDITOR"
]
},
"scopes": {
"type": "object",
"properties": {
"stats": {
"enum": [
"none",
"view",
"manage"
]
},
"finance": {
"enum": [
"none",
"view",
"manage"
]
},
"menu": {
"enum": [
"none",
"view",
"manage"
]
},
"warehouse": {
"enum": [
"none",
"view",
"manage"
]
},
"marketing": {
"enum": [
"none",
"view",
"manage"
]
},
"access": {
"enum": [
"none",
"view",
"manage"
]
}
},
"required": [],
"additionalProperties": false
},
"expires_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"grant_id"
],
"additionalProperties": false
}POSTaccess.grants.revokeТолько JWT владельца · изменяет данные
Отозвать предоставленный доступ
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/access.grants.revoke/
Тело запроса:
{
"type": "object",
"properties": {
"grant_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"grant_id"
],
"additionalProperties": false
}POSTaccess.invites.listТолько JWT владельца · чтение
Просмотреть invite-коды сотрудников
/api/v2/restaurants/{restaurant_id}/operations/access.invites.list/
Тело запроса:
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}POSTaccess.invites.createТолько JWT владельца · изменяет данные
Создать invite-код сотрудника
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/access.invites.create/
Тело запроса:
{
"type": "object",
"properties": {
"role": {
"enum": [
"WAITER",
"HEAD_WAITER",
"HOSTESS",
"CHEF",
"COOK",
"HEAD_CHEF",
"BARTENDER",
"SHIFT_LEADER",
"DISPATCHER",
"COURIER",
"MANAGER"
]
}
},
"required": [
"role"
],
"additionalProperties": false
}POSTaccess.invites.revokeТолько JWT владельца · изменяет данные
Отозвать неиспользованный invite-код
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/access.invites.revoke/
Тело запроса:
{
"type": "object",
"properties": {
"invite_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"invite_id"
],
"additionalProperties": false
}POSTaccess.pos_roles.listТолько JWT владельца · чтение
Просмотреть шаблоны кастомных POS-ролей
/api/v2/restaurants/{restaurant_id}/operations/access.pos_roles.list/
Тело запроса:
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}POSTaccess.pos_roles.createТолько JWT владельца · изменяет данные
Создать шаблон POS-роли; не меняет роль аккаунта сотрудника
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/access.pos_roles.create/
Тело запроса:
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"scopes": {
"type": "array",
"items": {
"enum": [
"orders.read",
"orders.write",
"orders.pay",
"menu.read",
"menu.write",
"tables.read",
"tables.write",
"bookings.read",
"bookings.write",
"inventory.read",
"inventory.write",
"staff.read",
"kitchen.read",
"analytics.read",
"finances.read"
]
},
"minItems": 1,
"uniqueItems": true
},
"pin_required": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"name",
"scopes"
],
"additionalProperties": false
}POSTaccess.pos_roles.updateТолько JWT владельца · изменяет данные
Изменить шаблон POS-роли
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/access.pos_roles.update/
Тело запроса:
{
"type": "object",
"properties": {
"role_id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"scopes": {
"type": "array",
"items": {
"enum": [
"orders.read",
"orders.write",
"orders.pay",
"menu.read",
"menu.write",
"tables.read",
"tables.write",
"bookings.read",
"bookings.write",
"inventory.read",
"inventory.write",
"staff.read",
"kitchen.read",
"analytics.read",
"finances.read"
]
},
"minItems": 1,
"uniqueItems": true
},
"pin_required": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"role_id"
],
"additionalProperties": false
}POSTaccess.pos_roles.deleteТолько JWT владельца · изменяет данные
Удалить шаблон POS-роли
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/access.pos_roles.delete/
Тело запроса:
{
"type": "object",
"properties": {
"role_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"role_id"
],
"additionalProperties": false
}Интеграции
POSTintegrations.iiko.statusТолько JWT владельца · чтение
Состояние подключения iiko без вывода ключа
/api/v2/restaurants/{restaurant_id}/operations/integrations.iiko.status/
Тело запроса:
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}POSTintegrations.iiko.configureТолько JWT владельца · изменяет данные
Настроить подключение iiko
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/integrations.iiko.configure/
Тело запроса:
{
"type": "object",
"properties": {
"api_key": {
"type": "string",
"maxLength": 255,
"writeOnly": true
},
"organization_id": {
"type": "string",
"maxLength": 64
}
},
"required": [],
"additionalProperties": false
}Автоматизации
POSTbackoffice.webhooks.listТолько JWT владельца · чтение
Получатели событий выбранного заведения; секреты и URL-токены скрыты
/api/v2/restaurants/{restaurant_id}/operations/backoffice.webhooks.list/
Тело запроса:
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}POSTbackoffice.webhooks.createТолько JWT владельца · изменяет данные
Подключить публичный HTTPS webhook; подписывающий секрет выдаётся владельцу
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/backoffice.webhooks.create/
Тело запроса:
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"url": {
"type": "string",
"format": "uri",
"minLength": 1,
"maxLength": 2048
},
"events": {
"type": "array",
"items": {
"enum": [
"order.created",
"order.updated",
"stock.movement",
"platform.operation"
]
},
"minItems": 1,
"maxItems": 4,
"uniqueItems": true
},
"is_active": {
"type": "boolean"
},
"rotate_secret": {
"type": "boolean"
}
},
"required": [
"name",
"url",
"events"
],
"additionalProperties": false
}POSTbackoffice.webhooks.updateТолько JWT владельца · изменяет данные
Изменить получателя, отключить отправку или сменить подписывающий секрет
Действие требует подтверждения владельца.
/api/v2/restaurants/{restaurant_id}/operations/backoffice.webhooks.update/
Тело запроса:
{
"type": "object",
"properties": {
"endpoint_id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"url": {
"type": "string",
"format": "uri",
"minLength": 1,
"maxLength": 2048
},
"events": {
"type": "array",
"items": {
"enum": [
"order.created",
"order.updated",
"stock.movement",
"platform.operation"
]
},
"minItems": 1,
"maxItems": 4,
"uniqueItems": true
},
"is_active": {
"type": "boolean"
},
"rotate_secret": {
"type": "boolean"
}
},
"required": [
"endpoint_id"
],
"additionalProperties": false
}POSTbackoffice.webhooks.deliveriesТолько JWT владельца · чтение
Доставки, HTTP-статусы и число попыток без response body/секретов
/api/v2/restaurants/{restaurant_id}/operations/backoffice.webhooks.deliveries/
Тело запроса:
{
"type": "object",
"properties": {
"endpoint_id": {
"type": "string",
"format": "uuid"
}
},
"required": [],
"additionalProperties": false
}POSTbackoffice.webhooks.retryТолько JWT владельца · изменяет данные
Повторить неуспешную доставку с тем же event id; бизнес-операция не повторяется
/api/v2/restaurants/{restaurant_id}/operations/backoffice.webhooks.retry/
Тело запроса:
{
"type": "object",
"properties": {
"delivery_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"delivery_id"
],
"additionalProperties": false
}Ошибки с машинным кодом
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Проверь параметры операции.",
"details": {"field": "Причина ошибки"}
},
"meta": {"api_version": "2", "request_id": "…"}
}| HTTP | Причина | Действие |
|---|---|---|
| 400 | Неверные параметры или нет Idempotency-Key | Проверьте input_schema |
| 401 / 403 | Авторизация, права, ограничения ключа | Проверьте секрет и permissions |
| 404 | Заведение или объект недоступны | Выберите объект из своего контура |
| 409 | Повторный ключ с другим телом или обработанное подтверждение | Используйте новый ключ для новой команды |
| 413 | Команда больше 64 КБ | Уменьшите запрос |
| 422 | Бизнес-правило не позволило выполнить действие | Проверьте состояние объекта |
| 429 | Лимит запросов или дневная квота | Снизьте частоту запросов |
| 500 / 502 | Ошибка исполнителя | Сохраните request_id для поддержки |