Kuryerlər üçün istinad kitabçalarını əldə et

GET/api/crm/v2/couriers_list.fieldsv2

operationId: couriersList.fields

Avtorizasiya

api-token + language + role

Sorğu parametrləri

branch_idintegermütləq

Nümunə: 1

Cavablar

object

statusstringmütləq

Dəyərlər:successerror

Nümunə: success

dataobject

district_idobject (FilterSelectInteger)

valueinteger

Nümunə: 8920

typestringmütləq

Nümunə: select

optionarray of object

valueintegermütləq

Nümunə: 8920

namestringmütləq

Nümunə: Green Basket | Kaliningrad

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

account_idinteger

Seçilmiş branch_id üçün hesabın ID-si

Nümunə: 3922

firm_user_idobject

Bütün hesab istifadəçiləri, operator xüsusiyyətləri və kuryer ayarlarına bağlılığı olanlar

typestring

Nümunə: select

optionarray of object

valueinteger

Nümunə: 825

namestring

Nümunə: user@fs.pro

has_operator_settingsboolean

Nümunə: false

has_courier_settingsboolean

Nümunə: false

distribution_methodobject (FilterEnum)

Filtr-siyahı — düz siyahı enum dəyərləri

valuestring

Nümunə: example

typestringmütləq

Nümunə: select

optionarray of string

modestring (FilterMode)

Dəyərlər:force_shownvalue_required

Nümunə: value_required

timezoneobject (FilterSelect)

valuestring

Nümunə: example

typestringmütləq

Nümunə: select

optionarray of object

valuestringmütləq

Nümunə: example

namestringmütləq

Nümunə: All

modestring (FilterMode)

Dəyərlər:force_shownvalue_required

Nümunə: value_required

default_languagestring

Nümunə: 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' => 'az', '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": "az", "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": "az", "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" } }