Ստանալ ուղեցույցներ դեսպանների համար

GET/api/crm/v2/couriers_list.fieldsv2

operationId: couriersList.fields

Հավաստագրում

api-token + language + role

Հարցման պարամետրեր

branch_idintegerպարտադիր

Օրինակ: 1

Պատասխաններ

object

statusstringպարտադիր

Արժեքներ:successerror

Օրինակ: success

dataobject

district_idobject (FilterSelectInteger)

valueinteger

Օրինակ: 8920

typestringպարտադիր

Օրինակ: select

optionarray of object

valueintegerպարտադիր

Օրինակ: 8920

namestringպարտադիր

Օրինակ: Green Basket | Kaliningrad

modestring (FilterMode)

Ինչպես է ինտերֆեյսը մշակում ֆիլտրը; սովորական ֆիլտրի համար mode չկա։ force_shown — միշտ ցուցադրվում է, հնարավոր չէ թաքցնել։ value_required — բաժնի մուտքի կետն է. միշտ ցուցադրվում է, չունի դատարկ արժեք (քանի դեռ արժեքը ընտրված չէ, ցուցակը դատարկ է; «բոլորը» տարբերակ չկա), ընդհանուր մաքրելը չի մաքրում այն։.

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

account_idinteger

Ընտրված branch_id-ի հաշվի ID

Օրինակ: 3922

firm_user_idobject

Բոլոր օգտատերերը հաշվի, որոնք ունեն օպերատորի հատկանիշներ և կապված են առաքիչի կարգավորումների հետ

typestring

Օրինակ: select

optionarray of object

valueinteger

Օրինակ: 825

namestring

Օրինակ: user@fs.pro

has_operator_settingsboolean

Օրինակ: false

has_courier_settingsboolean

Օրինակ: false

distribution_methodobject (FilterEnum)

Զտիչ-թվարկում — թվարկման արժեքների հարթ ցուցակ

valuestring

Օրինակ: example

typestringպարտադիր

Օրինակ: select

optionarray of string

modestring (FilterMode)

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

timezoneobject (FilterSelect)

valuestring

Օրինակ: example

typestringպարտադիր

Օրինակ: select

optionarray of object

valuestringպարտադիր

Օրինակ: example

namestringպարտադիր

Օրինակ: All

modestring (FilterMode)

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

default_languagestring

Օրինակ: 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' => 'hy', '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": "hy", "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": "hy", "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" } }