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

GET/api/crm/v2/couriers_list.fieldsv2

operationId: couriersList.fields

Авторизация

api-token + language + role

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

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

Пример: 1

Ответы

object

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

Значения:successerror

Пример: success

dataobject

district_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

account_idinteger

ID аккаунта выбранного branch_id

Пример: 3922

firm_user_idobject

Все пользователи аккаунта с признаками оператора и привязки к настройкам курьера

typestring

Пример: select

optionarray of object

valueinteger

Пример: 825

namestring

Пример: user@fs.pro

has_operator_settingsboolean

Пример: false

has_courier_settingsboolean

Пример: false

distribution_methodobject (FilterEnum)

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

valuestring

Пример: example

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

Пример: select

optionarray of string

modestring (FilterMode)

Значения:force_shownvalue_required

Пример: value_required

timezoneobject (FilterSelect)

valuestring

Пример: example

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

Пример: select

optionarray of object

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

Пример: example

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

Пример: All

modestring (FilterMode)

Значения:force_shownvalue_required

Пример: value_required

default_languagestring

Пример: ru

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

const response = await fetch("https://foodsoul.pro/api/crm/v2/couriers_list.fields?branch_id=1", { 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.pro/api/crm/v2/couriers_list.fields?branch_id=1", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "district_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "account_id": 3922, "firm_user_id": { "type": "select", "option": [ { "value": 825, "name": "user@fs.pro", "has_operator_settings": false, "has_courier_settings": false } ] }, "distribution_method": { "value": "example", "type": "select", "option": [ "string" ], "mode": "value_required" }, "timezone": { "value": "example", "type": "select", "option": [ { "value": "example", "name": "All" } ], "mode": "value_required" }, "default_language": "ru" } }