Получить справочники для филиалов

GET/api/crm/v2/branches.fieldsv2

operationId: branches.fields

Возвращает справочники для формы филиала. Параметры chain_id и city_id обязательны.

Авторизация

api-token + language + role

Параметры запроса

chain_idintegerобязательный

Пример: 7158

city_idintegerобязательный

Пример: 7158

Ответы

object

statusstringобязательный

Значения:successerror

Пример: success

dataobject

Для создания — city_id (нужен параметр city_id), для изменения — city (без параметра city_id)

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

round_costs_modeobject (FilterEnum)

Фильтр-перечисление — плоский список значений перечисления

valuestring

Пример: example

typestringобязательный

Пример: select

optionarray of string

modestring (FilterMode)

Значения:force_shownvalue_required

Пример: value_required

service_nameobject (FilterEnum)

Фильтр-перечисление — плоский список значений перечисления

valuestring

Пример: example

typestringобязательный

Пример: select

optionarray of string

modestring (FilterMode)

Значения:force_shownvalue_required

Пример: value_required

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.ru/api/crm/v2/branches.fields?chain_id=7158&city_id=7158', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'ru', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.ru/api/crm/v2/branches.fields?chain_id=7158&city_id=7158", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.ru/api/crm/v2/branches.fields?chain_id=7158&city_id=7158", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "branch_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "round_costs_mode": { "value": "example", "type": "select", "option": [ "string" ], "mode": "value_required" }, "service_name": { "value": "example", "type": "select", "option": [ "string" ], "mode": "value_required" } } }