API

Obtenir les référentiels pour les coursiers

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

Autorisation

api-token + language + role

Paramètres de requête

branch_idintegerobligatoire

Exemple: 1

Réponses

OK

object
statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject
district_idobject (FilterSelectInteger)
valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object
valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

account_idinteger

ID du compte pour le branch_id sélectionné

Exemple: 3922

firm_user_idobject

Tous les utilisateurs du compte ayant les attributs d'opérateur et une liaison aux paramètres du coursier

typestring

Exemple: select

optionarray of object
valueinteger

Exemple: 825

namestring

Exemple: user@fs.pro

has_operator_settingsboolean

Exemple: false

has_courier_settingsboolean

Exemple: false

distribution_methodobject (FilterEnum)

Filtre d’énumération — liste plate de valeurs d’énumération

valuestring

Exemple: example

typestringobligatoire

Exemple: select

optionarray of string
modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

timezoneobject (FilterSelect)
valuestring

Exemple: example

typestringobligatoire

Exemple: select

optionarray of object
valuestringobligatoire

Exemple: example

namestringobligatoire

Exemple: All

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

default_languagestring

Exemple: ru