Stopp-Liste abrufen

GET/api/crm/v2/items_stop_listv2

operationId: itemsStopList.default

Gibt die Stoppliste zurück. Die Liste enthält nur die Parameter von Artikeln mit aktiviertem stop_list_enabled.

Autorisierung

api-token + language + role

Abfrageparameter

branch_idinteger

Beispiel: 1

category_namestring

Beispiel: Pizza

item_namestring

Beispiel: Pizza

Antworten

object

statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject

branch_idinteger

Beispiel: 1

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

category_nameobject (FilterInput)

valuestring

Beispiel: example

typestringerforderlich

Beispiel: integer or string

placeholderstring

Beispiel: string

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

item_nameobject (FilterInput)

valuestring

Beispiel: example

typestringerforderlich

Beispiel: integer or string

placeholderstring

Beispiel: string

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

listarray of object

idintegererforderlich

Beispiel: 94060229

stock_balanceintegererforderlich

Beispiel: 1

stop_list_enabledbooleanerforderlich

Beispiel: true

namestringerforderlich

Beispiel: Mussels in cream sauce - 501 g

category_namestringerforderlich

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