Hangi stop-nimekiri

GET/api/crm/v2/items_stop_listv2

operationId: itemsStopList.default

Tagastab stop-nimekirja. Loend sisaldab ainult nende toodete parameetreid, millel on stop_list_enabled sisse lülitatud.

Autoriseerimine

api-token + language + role

Päringu parameetrid

branch_idinteger

Näide: 1

category_namestring

Näide: Pizza

item_namestring

Näide: Pizza

Vastused

object

statusstringkohustuslik

Väärtused:successerror

Näide: success

dataobject

branch_idinteger

Näide: 1

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object

valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

category_nameobject (FilterInput)

valuestring

Näide: example

typestringkohustuslik

Näide: integer or string

placeholderstring

Näide: string

modestring (FilterMode)

Väärtused:force_shownvalue_required

Näide: value_required

item_nameobject (FilterInput)

valuestring

Näide: example

typestringkohustuslik

Näide: integer or string

placeholderstring

Näide: string

modestring (FilterMode)

Väärtused:force_shownvalue_required

Näide: value_required

listarray of object

idintegerkohustuslik

Näide: 94060229

stock_balanceintegerkohustuslik

Näide: 1

stop_list_enabledbooleankohustuslik

Näide: true

namestringkohustuslik

Näide: Mussels in cream sauce - 501 g

category_namestringkohustuslik

Näide: 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' => 'et', '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": "et", "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": "et", "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" } ] } }