Limvero

Довідник API.

Реалізовані публічні точки API, права, параметри, пагінація і межі помилок для інтеграцій Limvero.

Межа публічних обіцянок
Публічні сторінки Limvero описують реалізовані можливості продукту і явно позначені плани розвитку. Сертифікація, фіскалізація, платежі, маркетплейси, uptime і логотипи клієнтів зʼявляються тільки тоді, коли ці факти реальні та задокументовані.
Розділи Developer Portal
Початок роботиАвтентифікаціяДовідник APIПагінаціяПомилкиRate limitsВебхукиVersioningMCPБезпекаКонтакт

Реалізовані endpoints

Цей список будується з того самого OpenAPI-обʼєкта, який віддає/developers/openapi.json. Якщо endpoint не присутній у цьому OpenAPI, його не можна рекламувати як доступний public API.

GET/api/v1/public/menu/items

Список позицій меню

Читає effective-меню вибраної точки і каналу з обмеженою курсорною пагінацією.

public.readmenu.read

Query parameters

limit
optional
Максимальна кількість записів у відповіді. Сервер приймає значення 1-100.
cursor
optional
Курсор з pagination.nextPageToken.
q
optional
Пошук за назвою позиції меню або SKU без урахування регістру.
categoryId
optional
Фільтр за категорією меню всередині клієнта API-ключа.
locationId
обовʼязково
Обовʼязкова точка клієнта. Відповідь використовує ціни і видимість цієї точки.
salesChannel
optional
Канал видимості меню. За замовчуванням використовується QR.
Значення: POS, QR, DELIVERY
status
optional
Фільтр за статусом позиції меню.
Значення: ACTIVE, STOP_LIST, ARCHIVED

Response codes

200400401403404429
{
  "data": [],
  "pagination": {
    "nextPageToken": null,
    "hasMore": false
  }
}
GET/api/v1/public/orders

Список замовлень

Читає списки замовлень у межах клієнта з обмеженими фільтрами і курсорною пагінацією.

public.readorders.read

Query parameters

limit
optional
Максимальна кількість записів у відповіді. Сервер приймає значення 1-100.
cursor
optional
Курсор з pagination.nextPageToken.
locationId
optional
Фільтр за точкою клієнта.
status
optional
Фільтр за статусом замовлення.
Значення: OPEN, SENT_TO_KITCHEN, PAID, CLOSED, CANCELLED
activeOnly
optional
Якщо true, повертає відкриті й відправлені на кухню замовлення.

Response codes

200400401403404429
{
  "data": [],
  "pagination": {
    "nextPageToken": null,
    "hasMore": false
  }
}

Правила запитів

Інтеграції мають бути обмеженими, привʼязаними до клієнта і явними в пагінації та обробці помилок.

Курсорна пагінація

Клієнти списків передають limit і cursor, читають поточну сторінку і продовжують тільки доки pagination.hasMore дорівнює true.

Межа клієнта

API-ключ привʼязаний до одного клієнта. Публічні точки API не дозволяють читати дані іншого ресторану.

Межа прав

Кожне заявлене право точки API обовʼязкове. Якщо endpoint вимагає два scopes, ключ має містити обидва.

Модель помилок

Поточний public API документує реальний Nest-style error body з message, statusCode і error до переходу на problem-details envelope.

Без бойової консолі

Публічні сторінки не відкривають production try-it. Реальні ключі використовуються тільки у власному контрольованому середовищі клієнта.

Без прихованих write endpoints

Створення клієнтів, зовнішніх замовлень, зміна меню, лояльності, оплат і складу залишаються roadmap, доки не мають окремих scopes і тестів.

Source of truth
OpenAPI JSON, ця сторінка, майбутня Postman collection і SDK повинні оновлюватися разом. Ручні приклади не можуть додавати endpoints або scopes, яких немає в реалізованому backend-контракті.

Оберіть продукт для вашого бізнесу.

Limvero Restaurant і Limvero Retail мають окремі сценарії запуску, входи й робочі процеси на спільній захищеній платформі.

Limvero RestaurantLimvero Retail