☰ Menü · Menü
API referansı

Menü

İşletmenin QR menüsü: kategoriler, ürünler, opsiyonlar, fiyatlar ve tükenenler listesi.

Ürünler, kategoriler ve opsiyon değerleri, işletme bazında benzersiz olan kendi external_id değerinizi (SKU) taşıyabilir. Yolda {item} veya {value} geçen her yerde bizim id'mizi ya da sizin external_id değerinizi kullanabilirsiniz. Ad ve açıklamalar dile göre eşlemlerdir ({"ro": "Zeamă", "en": "Chicken soup"}). Tek dilde düz metin almak için herhangi bir GET isteğine ?lang=en ekleyin. Çeviri yoksa menünün ana dili kullanılır.

GET/v1/menu
İzin: menu:read

Menünün tamamı ağaç yapısında: kategoriler, ürünleri, her ürünün opsiyon grupları ve değerleri. Gizli kategoriler ve ürünler, ?include_hidden=true eklemediğiniz sürece dahil edilmez.

curl
curl "https://loyaltyfy.io/api/v1/menu?lang=en" \
  -H "Authorization: Bearer sk_test_..."
Yanıt · 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
İzin: menu:read

Opsiyonlar olmadan, menü sırasıyla en fazla 1000 üründen oluşan düz liste. Filtreler: tek bir SKU için ?external_id=, güncel tükenenler listesi için ?available=false, ?lang=.

GET/v1/menu/items/{item}
İzin: menu:read

Opsiyonlarıyla birlikte tek bir ürün.

POST/v1/menu/items
İzin: menu:write

Ürün ekler. external_id ile gönderilen istek güvenle tekrarlanabilir: bu external_id ile mevcut bir ürün varsa 200 ile döner.

categorystring, zorunlu
Kategori id'si veya kategorinin external_id değeri. Bilinmeyen bir değer bu adla yeni kategori oluşturur.
namenesne, zorunlu
Dile göre ad, en az bir dilde.
priceinteger, zorunlu
En küçük para biriminde.
external_idstring
Sizin SKU'nuz.
descriptionnesne
Dile göre.
available, visibleboolean
Varsayılan 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}
İzin: menu:write

price, old_price (üstü çizili gösterilir), available, visible, external_id, name veya description değerlerini değiştirir. menu.updated gönderir.

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
İzin: menu:write

Tek istekte en fazla 500 değişiklik. Her kayıt bir ürünü item (id veya external_id) ile belirtir ve price, old_price, available, visible alanlarından istediklerini ayarlar. Hiçbir şeyi değiştirmeyen kayıtlar unchanged, bilinmeyenler not_found içinde döner. Toplu istek için tek bir menu.updated olayı gönderilir.

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 }
    ]
  }'
Yanıt · 200
{
  "object": "menu_bulk_result",
  "updated": ["1001", "2040"],
  "unchanged": [],
  "not_found": ["3017"],
  "failed": []
}
PATCH/v1/menu/option_values/{value}
İzin: menu:write

Bir opsiyon değerini değiştirir: 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 }'
Entegrasyonla ilgili sorularınız için: api@loyaltyfy.io. Bir iş günü içinde yanıt veriyoruz.