Získat stop-list

GET/api/crm/v2/items_stop_listv2

operationId: itemsStopList.default

Vrací stop-list. Do seznamu jsou zahrnuty pouze parametry položek s povoleným stop_list_enabled.

Autorizace

api-token + language + role

Parametry dotazu

branch_idinteger

Příklad: 1

category_namestring

Příklad: Pizza

item_namestring

Příklad: Pizza

Odpovědi

object

statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobject

branch_idinteger

Příklad: 1

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object

valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

category_nameobject (FilterInput)

valuestring

Příklad: example

typestringpovinné

Příklad: integer or string

placeholderstring

Příklad: string

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

item_nameobject (FilterInput)

valuestring

Příklad: example

typestringpovinné

Příklad: integer or string

placeholderstring

Příklad: string

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

listarray of object

idintegerpovinné

Příklad: 94060229

stock_balanceintegerpovinné

Příklad: 1

stop_list_enabledbooleanpovinné

Příklad: true

namestringpovinné

Příklad: Mussels in cream sauce - 501 g

category_namestringpovinné

Příklad: 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' => 'cs', '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": "cs", "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": "cs", "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" } ] } }