API

Get reference data for couriers

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

Authorization

api-token + language + role

Query parameters

branch_idintegerrequired

Example: 1

Responses

OK

object
statusstringrequired

Values:successerror

Example: success

dataobject
district_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

account_idinteger

Account ID of the selected branch_id

Example: 3922

firm_user_idobject

All account users with operator roles and linked to courier settings

typestring

Example: select

optionarray of object
valueinteger

Example: 825

namestring

Example: user@fs.pro

has_operator_settingsboolean

Example: false

has_courier_settingsboolean

Example: false

distribution_methodobject (FilterEnum)

Filter enumeration — a flat list of enumeration values

valuestring

Example: example

typestringrequired

Example: select

optionarray of string
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

timezoneobject (FilterSelect)
valuestring

Example: example

typestringrequired

Example: select

optionarray of object
valuestringrequired

Example: example

namestringrequired

Example: All

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

default_languagestring

Example: ru