☰ Меню · Меню

Довідник API

Страви, категорії та значення модифікаторів можуть мати ваш external_id (ваш артикул), унікальний у межах закладу. Скрізь, де в шляху є {item} або {value}, можна вказувати наш id або ваш external_id. Назви та описи передаються як об’єкти з мовами ({"ro": "Zeamă", "en": "Chicken soup"}). Додайте ?lang=en до будь-якого GET-запиту, щоб отримати звичайні рядки однією мовою. Якщо перекладу немає, використовується основна мова меню.

GET/v1/menu

Право: menu:read

Усе меню у вигляді дерева: категорії, їхні страви, групи модифікаторів і значення кожної страви. Приховані категорії та страви не повертаються, якщо не додати ?include_hidden=true.

curl

curl "https://loyaltyfy.io/api/v1/menu?lang=en" \
  -H "Authorization: Bearer sk_test_..."

Відповідь · 200

{
  "object": "menu",
  "url": "https://loyaltyfy.io/m/your-venue",
  "published": true,
  "currency": "MDL",
  "primary_language": "ro",
  "languages": ["ru", "en"],
  "categories": [
    {
      "object": "menu_category",
      "id": "0b8e4c1d-6f0e-4b8a-9a55-3c1d2e7f9a10",
      "external_id": "CAT-COFFEE",
      "parent_id": null,
      "name": "Coffee",
      "emoji": null,
      "visible": true,
      "items": [
        {
          "object": "menu_item",
          "id": "a48343bd-9f6e-424a-b003-fe790617f4d6",
          "external_id": "1001",
          "category_id": "0b8e4c1d-6f0e-4b8a-9a55-3c1d2e7f9a10",
          "name": "Flat white",
          "description": "Double ristretto, steamed milk",
          "price": 4500,
          "old_price": null,
          "currency": "MDL",
          "available": true,
          "visible": true,
          "photo_url": "https://...",
          "options": [
            {
              "object": "option_group",
              "id": "5c2f...",
              "kind": "addon",
              "name": "Milk",
              "min_select": 0,
              "max_select": 1,
              "values": [
                {
                  "object": "option_value",
                  "id": "9e41...",
                  "external_id": "MOD-OAT",
                  "name": "Oat milk",
                  "price_delta": 800,
                  "available": true,
                  "default": false
                }
              ]
            }
          ],
          "updated_at": "2026-10-06T09:12:44.120+00:00"
        }
      ]
    }
  ]
}

GET/v1/menu/items

Право: menu:read

Плоский список страв без модифікаторів, до 1000, у порядку меню. Фільтри: ?external_id= для одного артикулу, ?available=false для поточного стоп-листа, ?lang=.

GET/v1/menu/items/{item}

Право: menu:read

Одна страва з модифікаторами.

POST/v1/menu/items

Право: menu:write

Додає страву. З external_id запит можна безпечно повторювати: наявна страва з цим external_id повертається з 200.

categorystring, обов’язковий: Id категорії або external_id категорії. Невідоме значення створює категорію з такою назвою.
nameobject, обов’язковий: Назва за мовами, щонайменше одна.
priceinteger, обов’язковий: У дрібних одиницях.
external_idstring: Ваш артикул.
descriptionobject: За мовами.
available, visibleboolean: За замовчуванням true.

Параметр	Тип	Опис
category	string, обов’язковий	Id категорії або `external_id` категорії. Невідоме значення створює категорію з такою назвою.
name	object, обов’язковий	Назва за мовами, щонайменше одна.
price	integer, обов’язковий	У дрібних одиницях.
external_id	string	Ваш артикул.
description	object	За мовами.
available, visible	boolean	За замовчуванням true.

curl

curl https://loyaltyfy.io/api/v1/menu/items \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "category": "CAT-SOUPS",
    "external_id": "2040",
    "name": { "ro": "Zeamă", "ru": "Зама", "en": "Chicken soup" },
    "price": 6500
  }'

PATCH/v1/menu/items/{item}

Право: menu:write

Змінює price, old_price (показується закресленою), available, visible, external_id, name або description. Надсилає menu.updated.

curl

# the kitchen ran out: hide the "+" button in the menu
curl -X PATCH https://loyaltyfy.io/api/v1/menu/items/2040 \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "available": false }'

POST/v1/menu/items/bulk

Право: menu:write

До 500 змін за один запит. Кожен запис звертається до страви через item (id або external_id) і задає будь-які з полів price, old_price, available, visible. Записи, які нічого не змінюють, повертаються в unchanged, невідомі в not_found. Для всього пакета надсилається одна подія menu.updated.

curl

curl https://loyaltyfy.io/api/v1/menu/items/bulk \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      { "item": "1001", "price": 4800 },
      { "item": "2040", "available": false },
      { "item": "3017", "price": 9900, "old_price": 12000 }
    ]
  }'

Відповідь · 200

{
  "object": "menu_bulk_result",
  "updated": ["1001", "2040"],
  "unchanged": [],
  "not_found": ["3017"],
  "failed": []
}

PATCH/v1/menu/option_values/{value}

Право: menu:write

Змінює значення модифікатора: available, price_delta, external_id.

curl

curl -X PATCH https://loyaltyfy.io/api/v1/menu/option_values/MOD-OAT \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "available": false }'