Gauti stop sąrašą

GET/api/crm/v2/items_stop_listv2

operationId: itemsStopList.default

Grąžina stop sąrašą. Į sąrašą įtraukiami tik prekių parametrai su įjungtu stop_list_enabled.

Autorizacija

api-token + language + role

Užklausos parametrai

branch_idinteger

Pavyzdys: 1

category_namestring

Pavyzdys: Pizza

item_namestring

Pavyzdys: Pizza

Atsakymai

object

statusstringprivalomas

Reikšmės:successerror

Pavyzdys: success

dataobject

branch_idinteger

Pavyzdys: 1

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object

valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

category_nameobject (FilterInput)

valuestring

Pavyzdys: example

typestringprivalomas

Pavyzdys: integer or string

placeholderstring

Pavyzdys: string

modestring (FilterMode)

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

item_nameobject (FilterInput)

valuestring

Pavyzdys: example

typestringprivalomas

Pavyzdys: integer or string

placeholderstring

Pavyzdys: string

modestring (FilterMode)

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

listarray of object

idintegerprivalomas

Pavyzdys: 94060229

stock_balanceintegerprivalomas

Pavyzdys: 1

stop_list_enabledbooleanprivalomas

Pavyzdys: true

namestringprivalomas

Pavyzdys: Mussels in cream sauce - 501 g

category_namestringprivalomas

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