Stok bakiyelerini al

GET/api/crm/v2/items_stock_balancev2

operationId: itemsStockBalance.default

Şubenin ürün stok bakiyelerini döndürür. Listeye yalnızca stock_balance_enabled etkin olan ürün parametreleri dahil edilir.

Yetkilendirme

api-token + language + role

Sorgu parametreleri

branch_idinteger

Örnek: 1

category_namestring

Örnek: Pizza

item_namestring

Örnek: Pizza

Yanıtlar

object

statusstringzorunlu

Değerler:successerror

Örnek: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object

valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

category_nameobject (FilterInput)

valuestring

Örnek: example

typestringzorunlu

Örnek: integer or string

placeholderstring

Örnek: string

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

item_nameobject (FilterInput)

valuestring

Örnek: example

typestringzorunlu

Örnek: integer or string

placeholderstring

Örnek: string

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

listarray of object

idintegerzorunlu

Örnek: 94060753

stock_balanceintegerzorunlu

Örnek: 1

stop_list_enabledbooleanzorunlu

Örnek: true

namestringzorunlu

Örnek: Mussels in cream sauce - 501 g

category_namestringzorunlu

Örnek: Seafood

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/items_stock_balance', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'tr', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/items_stock_balance", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "tr", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/items_stock_balance", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "tr", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "filters": { "branch_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "category_name": { "value": "example", "type": "integer or string", "placeholder": "string", "mode": "value_required" }, "item_name": { "value": "example", "type": "integer or string", "placeholder": "string", "mode": "value_required" } }, "list": [ { "id": 94060753, "stock_balance": 1, "stop_list_enabled": true, "name": "Mussels in cream sauce - 501 g", "category_name": "Seafood" } ] } }