Iegūt kurjeru uzziņu sarakstus

GET/api/crm/v2/couriers_list.fieldsv2

operationId: couriersList.fields

Autorizācija

api-token + language + role

Vaicājuma parametri

branch_idintegerobligāts

Piemērs: 1

Atbildes

object

statusstringobligāts

Vērtības:successerror

Piemērs: success

dataobject

district_idobject (FilterSelectInteger)

valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object

valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

account_idinteger

Izvēlētā branch_id konta ID

Piemērs: 3922

firm_user_idobject

Visi konta lietotāji ar operatora statusu un piesaisti kurjera iestatījumiem

typestring

Piemērs: select

optionarray of object

valueinteger

Piemērs: 825

namestring

Piemērs: user@fs.pro

has_operator_settingsboolean

Piemērs: false

has_courier_settingsboolean

Piemērs: false

distribution_methodobject (FilterEnum)

Filtrs-enums — plakans uzskaitījuma vērtību saraksts

valuestring

Piemērs: example

typestringobligāts

Piemērs: select

optionarray of string

modestring (FilterMode)

Vērtības:force_shownvalue_required

Piemērs: value_required

timezoneobject (FilterSelect)

valuestring

Piemērs: example

typestringobligāts

Piemērs: select

optionarray of object

valuestringobligāts

Piemērs: example

namestringobligāts

Piemērs: All

modestring (FilterMode)

Vērtības:force_shownvalue_required

Piemērs: value_required

default_languagestring

Piemērs: 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' => 'lv', '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": "lv", "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": "lv", "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" } }