Obtener catálogos para los repartidores

GET/api/crm/v2/couriers_list.fieldsv2

operationId: couriersList.fields

Autorización

api-token + language + role

Parámetros de consulta

branch_idintegerobligatorio

Ejemplo: 1

Respuestas

object

statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject

district_idobject (FilterSelectInteger)

valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object

valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

account_idinteger

ID de la cuenta del branch_id seleccionado

Ejemplo: 3922

firm_user_idobject

Todos los usuarios de la cuenta con atributos de operador y vinculados a la configuración del repartidor

typestring

Ejemplo: select

optionarray of object

valueinteger

Ejemplo: 825

namestring

Ejemplo: user@fs.pro

has_operator_settingsboolean

Ejemplo: false

has_courier_settingsboolean

Ejemplo: false

distribution_methodobject (FilterEnum)

Filtro-enumeración: una lista plana de valores de enumeración

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: select

optionarray of string

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

timezoneobject (FilterSelect)

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: select

optionarray of object

valuestringobligatorio

Ejemplo: example

namestringobligatorio

Ejemplo: All

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

default_languagestring

Ejemplo: ru

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

const response = await fetch("https://foodsoul.ru/api/crm/v2/couriers_list.fields?branch_id=1", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "es", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.ru/api/crm/v2/couriers_list.fields?branch_id=1", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "es", "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" } }