Ստանալ stop-ցանկ

GET/api/crm/v2/items_stop_listv2

operationId: itemsStopList.default

Վերադարձնում է stop-ցանկը։ Ցանկում ընդգրկված են միայն այն ապրանքների պարամետրերը, որոնց մոտ միացված է stop_list_enabled։.

Հավաստագրում

api-token + language + role

Հարցման պարամետրեր

branch_idinteger

Օրինակ: 1

category_namestring

Օրինակ: Pizza

item_namestring

Օրինակ: Pizza

Պատասխաններ

object

statusstringպարտադիր

Արժեքներ:successerror

Օրինակ: success

dataobject

branch_idinteger

Օրինակ: 1

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Օրինակ: 8920

typestringպարտադիր

Օրինակ: select

optionarray of object

valueintegerպարտադիր

Օրինակ: 8920

namestringպարտադիր

Օրինակ: Green Basket | Kaliningrad

modestring (FilterMode)

Ինչպես է ինտերֆեյսը մշակում ֆիլտրը; սովորական ֆիլտրի համար mode չկա։ force_shown — միշտ ցուցադրվում է, հնարավոր չէ թաքցնել։ value_required — բաժնի մուտքի կետն է. միշտ ցուցադրվում է, չունի դատարկ արժեք (քանի դեռ արժեքը ընտրված չէ, ցուցակը դատարկ է; «բոլորը» տարբերակ չկա), ընդհանուր մաքրելը չի մաքրում այն։.

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

category_nameobject (FilterInput)

valuestring

Օրինակ: example

typestringպարտադիր

Օրինակ: integer or string

placeholderstring

Օրինակ: string

modestring (FilterMode)

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

item_nameobject (FilterInput)

valuestring

Օրինակ: example

typestringպարտադիր

Օրինակ: integer or string

placeholderstring

Օրինակ: string

modestring (FilterMode)

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

listarray of object

idintegerպարտադիր

Օրինակ: 94060229

stock_balanceintegerպարտադիր

Օրինակ: 1

stop_list_enabledbooleanպարտադիր

Օրինակ: true

namestringպարտադիր

Օրինակ: Mussels in cream sauce - 501 g

category_namestringպարտադիր

Օրինակ: 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' => 'hy', '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": "hy", "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": "hy", "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" } ] } }