API

Отримати довідники для кур'єрів

GET/api/crm/v2/couriers_list.fieldsv2
operationId: couriersList.fields

Авторизація

api-token + language + role

Параметри запиту

branch_idintegerобов’язковий

Приклад: 1

Відповіді

OK

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)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

timezoneobject (FilterSelect)
valuestring

Приклад: example

typestringобов’язковий

Приклад: select

optionarray of object
valuestringобов’язковий

Приклад: example

namestringобов’язковий

Приклад: All

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

default_languagestring

Приклад: ru