Pobierz listę stop

GET/api/crm/v2/items_stop_listv2

operationId: itemsStopList.default

Zwraca listę stop-list. Lista zawiera tylko parametry produktów z włączonym stop_list_enabled.

Autoryzacja

api-token + language + role

Parametry zapytania

branch_idinteger

Przykład: 1

category_namestring

Przykład: Pizza

item_namestring

Przykład: Pizza

Odpowiedzi

object

statusstringwymagane

Wartości:successerror

Przykład: success

dataobject

branch_idinteger

Przykład: 1

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object

valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

category_nameobject (FilterInput)

valuestring

Przykład: example

typestringwymagane

Przykład: integer or string

placeholderstring

Przykład: string

modestring (FilterMode)

Wartości:force_shownvalue_required

Przykład: value_required

item_nameobject (FilterInput)

valuestring

Przykład: example

typestringwymagane

Przykład: integer or string

placeholderstring

Przykład: string

modestring (FilterMode)

Wartości:force_shownvalue_required

Przykład: value_required

listarray of object

idintegerwymagane

Przykład: 94060229

stock_balanceintegerwymagane

Przykład: 1

stop_list_enabledbooleanwymagane

Przykład: true

namestringwymagane

Przykład: Mussels in cream sauce - 501 g

category_namestringwymagane

Przykład: 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' => 'pl', '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": "pl", "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": "pl", "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" } ] } }