Отримати стоп-лист

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' => 'uk', '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": "uk", "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": "uk", "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" } ] } }