Malzeme Kataloğu — GET /plugin-api/ingredients/list ✓ Canlı

Mağazanın malzeme/stok kataloğunu (reçete malzemeleri, envanter) döner. Stok/envanter eklentileri için. Snapshot; değişiklikler için ingredient.* event'leri.

← API Uçları · ortak kurallar (base, auth, hata zarfı) orada.

İstek

GET {RESTOMENUM_BASE}/plugin-api/ingredients/list
Authorization: Bearer {serverId}.{pluginId}.{secret}     // install API key (token exchange)
  • Base: Sandbox https://sandbox.plugins.restomenum.app, Production https://plugins.restomenum.app (API Uçları).
  • Parametre yok — tüm malzemeler döner.
  • Auth: Authorization: Bearer <apiKey>token exchange'teki install API key.
  • Scope: ingredients:read (envanter; satış/menü scope'larından ayrı).

Yanıt

Gerçek 200 örneği
{
  "success": true,
  "data": [
    { "id": "ab-12", "title": "Domates",    "unit": "kg", "stock": 42, "alert": 5,  "tax": 1 },
    { "id": "cd-34", "title": "Zeytinyağı", "unit": "lt", "stock": 8,  "alert": 10, "tax": 1 }
  ],
  "truncated": false
}
truncated: true → 2000 üstü malzeme var (sayfa sınırı; restoran ölçeğinde pratikte ulaşılmaz).

Alanlar

AlanTipAçıklama
idstringMalzeme id'si
titlestringMalzeme adı
unitstringBirim (kg, lt, adet…)
stocknumberToplam stok miktarı
alertnumberDüşük-stok uyarı eşiği
taxnumberVergi/KDV oranı

Sızıntı önlemi

ort (ortalama MALİYET = ticari sır) ASLA dönmez (ürün cost/recete gibi). stocks (depo-bazlı kırılım) ve storages (iç depo yapısı) dönmez — yalnız toplam stock.

data yalnız ingredients:read onaylıysa dolu; yoksa {}.

Hatalar

messageHTTPAnlam
plugin.scope.denied200ingredients:read onaylı değil
unauthorized401Geçersiz/eksik install key