Стоп-тізімді алу

GET/api/crm/v2/items_stop_listv2

operationId: itemsStopList.default

Стоп-листті қайтарады. Тізімге тек stop_list_enabled қосылған тауарлардың параметрлері кіреді.

Авторизация

api-token + language + role

Сұраныс параметрлері

branch_idinteger

Мысал: 1

category_namestring

Мысал: Pizza

item_namestring

Мысал: Pizza

Жауаптар

object

statusstringміндетті

Мәндер:successerror

Мысал: success

dataobject

branch_idinteger

Мысал: 1

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Мысал: 8920

typestringміндетті

Мысал: select

optionarray of object

valueintegerміндетті

Мысал: 8920

namestringміндетті

Мысал: Green Basket | Kaliningrad

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

category_nameobject (FilterInput)

valuestring

Мысал: example

typestringміндетті

Мысал: integer or string

placeholderstring

Мысал: string

modestring (FilterMode)

Мәндер:force_shownvalue_required

Мысал: value_required

item_nameobject (FilterInput)

valuestring

Мысал: example

typestringміндетті

Мысал: integer or string

placeholderstring

Мысал: string

modestring (FilterMode)

Мәндер:force_shownvalue_required

Мысал: value_required

listarray of object

idintegerміндетті

Мысал: 94060229

stock_balanceintegerміндетті

Мысал: 1

stop_list_enabledbooleanміндетті

Мысал: true

namestringміндетті

Мысал: Mussels in cream sauce - 501 g

category_namestringміндетті

Мысал: Seafood

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

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

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

{ "status": "success", "data": { "branch_id": 1, "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": 94060229, "stock_balance": 1, "stop_list_enabled": true, "name": "Mussels in cream sauce - 501 g", "category_name": "Seafood" } ] } }