Získat referenční údaje pro kurýry

GET/api/crm/v2/couriers_list.fieldsv2

operationId: couriersList.fields

Autorizace

api-token + language + role

Parametry dotazu

branch_idintegerpovinné

Příklad: 1

Odpovědi

object

statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobject

district_idobject (FilterSelectInteger)

valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object

valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

account_idinteger

ID účtu vybraného branch_id

Příklad: 3922

firm_user_idobject

Všichni uživatelé účtu s atributy operátora a přiřazením k nastavení kurýra

typestring

Příklad: select

optionarray of object

valueinteger

Příklad: 825

namestring

Příklad: user@fs.pro

has_operator_settingsboolean

Příklad: false

has_courier_settingsboolean

Příklad: false

distribution_methodobject (FilterEnum)

Filtr-enum — plochý seznam hodnot výčtu

valuestring

Příklad: example

typestringpovinné

Příklad: select

optionarray of string

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

timezoneobject (FilterSelect)

valuestring

Příklad: example

typestringpovinné

Příklad: select

optionarray of object

valuestringpovinné

Příklad: example

namestringpovinné

Příklad: All

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

default_languagestring

Příklad: 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' => 'cs', '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": "cs", "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": "cs", "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" } }