Obțineți directoare pentru curieri

GET/api/crm/v2/couriers_list.fieldsv2

operationId: couriersList.fields

Autorizare

api-token + language + role

Parametri de interogare

branch_idintegerobligatoriu

Exemplu: 1

Răspunsuri

object

statusstringobligatoriu

Valori:successerror

Exemplu: success

dataobject

district_idobject (FilterSelectInteger)

valueinteger

Exemplu: 8920

typestringobligatoriu

Exemplu: select

optionarray of object

valueintegerobligatoriu

Exemplu: 8920

namestringobligatoriu

Exemplu: Green Basket | Kaliningrad

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

account_idinteger

ID-ul contului pentru branch_id selectat

Exemplu: 3922

firm_user_idobject

Toți utilizatorii contului cu atribute de operator și asociați cu setările curierului

typestring

Exemplu: select

optionarray of object

valueinteger

Exemplu: 825

namestring

Exemplu: user@fs.pro

has_operator_settingsboolean

Exemplu: false

has_courier_settingsboolean

Exemplu: false

distribution_methodobject (FilterEnum)

Filtru-enumerație — listă plată de valori ale enumerației

valuestring

Exemplu: example

typestringobligatoriu

Exemplu: select

optionarray of string

modestring (FilterMode)

Valori:force_shownvalue_required

Exemplu: value_required

timezoneobject (FilterSelect)

valuestring

Exemplu: example

typestringobligatoriu

Exemplu: select

optionarray of object

valuestringobligatoriu

Exemplu: example

namestringobligatoriu

Exemplu: All

modestring (FilterMode)

Valori:force_shownvalue_required

Exemplu: value_required

default_languagestring

Exemplu: ru

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

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

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