სტოპ-ლისტის მიღება

GET/api/crm/v2/items_stop_listv2

operationId: itemsStopList.default

აბრუნებს სტოპ-ლისტს. სიაში შედის მხოლოდ იმ პროდუქტების პარამეტრები, რომლებსაც ჩართული აქვთ 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' => 'ka', '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": "ka", "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": "ka", "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" } ] } }