API

Abrufen von Nachschlagewerken für Kuriere

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

Autorisierung

api-token + language + role

Abfrageparameter

branch_idintegererforderlich

Beispiel: 1

Antworten

OK

object
statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject
district_idobject (FilterSelectInteger)
valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object
valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

account_idinteger

ID des Accounts der ausgewählten branch_id

Beispiel: 3922

firm_user_idobject

Alle Benutzer des Accounts mit den Merkmalen „Operator“ und einer Verknüpfung zu den Kuriereinstellungen

typestring

Beispiel: select

optionarray of object
valueinteger

Beispiel: 825

namestring

Beispiel: user@fs.pro

has_operator_settingsboolean

Beispiel: false

has_courier_settingsboolean

Beispiel: false

distribution_methodobject (FilterEnum)

Filter-Enum — flache Liste von Enumerationswerten

valuestring

Beispiel: example

typestringerforderlich

Beispiel: select

optionarray of string
modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

timezoneobject (FilterSelect)
valuestring

Beispiel: example

typestringerforderlich

Beispiel: select

optionarray of object
valuestringerforderlich

Beispiel: example

namestringerforderlich

Beispiel: All

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

default_languagestring

Beispiel: ru