Мәзір

Мекеменің QR-мәзірі: санаттар, тағамдар, модификаторлар, бағалар және стоп-лист.

Тағамдарда, санаттарда және модификатор мәндерінде мекеме ішінде бірегей external_id (сіздің SKU) болуы мүмкін. Жолда {item} немесе {value} бар жердің бәрінде біздің id-ді немесе өз external_id мәніңізді пайдалана аласыз. Атаулар мен сипаттамалар тіл бойынша карталар түрінде беріледі ({"ro": "Zeamă", "en": "Chicken soup"}). Бір тілдегі қарапайым жолдарды алу үшін кез келген GET сұрауына ?lang=en қосыңыз: аударма жоқ болса, мәзірдің негізгі тілі қолданылады.

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-ға дейін, мәзірдегі ретпен. Сүзгілер: бір SKU үшін ?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 мәні. Белгісіз мән осындай атаумен санат жасайды.
nameобъект, міндетті: Тіл бойынша атау, кемінде біреу.
priceinteger, міндетті: Кіші бірлікте.
external_idstring: Сіздің SKU.
descriptionобъект: Тіл бойынша.
available, visibleboolean: Әдепкі true.

Параметр	Түрі	Сипаттама
category	string, міндетті	Санат id-і немесе санаттың `external_id` мәні. Белгісіз мән осындай атаумен санат жасайды.
name	объект, міндетті	Тіл бойынша атау, кемінде біреу.
price	integer, міндетті	Кіші бірлікте.
external_id	string	Сіздің SKU.
description	объект	Тіл бойынша.
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 }'