Get reference data for the stop list form

GET/api/crm/v2/items_stop_list.fieldsv2

operationId: itemsStopList.fields

Returns reference data for the form. Parameters are labeled as category → parameter name.

Authorization

api-token + language + role

Query parameters

branch_idintegerrequired

Example: 8785

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

idobject (FilterSelectInteger)

valueinteger

Example: 8920

typestringrequired

Example: select

optionarray of object

valueintegerrequired

Example: 8920

namestringrequired

Example: Green Basket | Kaliningrad

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

curl -X GET 'https://foodsoul.ru/api/crm/v2/items_stop_list.fields?branch_id=8785' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: en' \
  -H 'role: partner'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://foodsoul.ru/api/crm/v2/items_stop_list.fields?branch_id=8785', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'en',
        'role' => 'partner',
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.ru/api/crm/v2/items_stop_list.fields?branch_id=8785", {
    method: "GET",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner"
    },
})
const data = await response.json()

import requests

response = requests.request(
    "GET",
    "https://foodsoul.ru/api/crm/v2/items_stop_list.fields?branch_id=8785",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
    },
)
data = response.json()

Response 200

{
  "status": "success",
  "data": {
    "id": {
      "value": 8920,
      "type": "select",
      "option": [
        {
          "value": 8920,
          "name": "Green Basket | Kaliningrad"
        }
      ],
      "mode": "value_required"
    }
  }
}

Requests are sent to foodsoul.ru — the host of this portal; you cannot choose another one.