Получить стоп-лист

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.pro/api/crm/v2/items_stop_list', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'ru', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

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

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/items_stop_list", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "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" } ] } }