Hangi saada kullerite teatmikud

GET/api/crm/v2/couriers_list.fieldsv2

operationId: couriersList.fields

Autoriseerimine

api-token + language + role

Päringu parameetrid

branch_idintegerkohustuslik

Näide: 1

Vastused

object

statusstringkohustuslik

Väärtused:successerror

Näide: success

dataobject

district_idobject (FilterSelectInteger)

valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object

valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

account_idinteger

Valitud branch_id konto ID

Näide: 3922

firm_user_idobject

Kõik konto kasutajad, kellel on operaatori tunnused ja seos kulleri seadistustega

typestring

Näide: select

optionarray of object

valueinteger

Näide: 825

namestring

Näide: user@fs.pro

has_operator_settingsboolean

Näide: false

has_courier_settingsboolean

Näide: false

distribution_methodobject (FilterEnum)

Filtri enum — tasane loend enum väärtustest

valuestring

Näide: example

typestringkohustuslik

Näide: select

optionarray of string

modestring (FilterMode)

Väärtused:force_shownvalue_required

Näide: value_required

timezoneobject (FilterSelect)

valuestring

Näide: example

typestringkohustuslik

Näide: select

optionarray of object

valuestringkohustuslik

Näide: example

namestringkohustuslik

Näide: All

modestring (FilterMode)

Väärtused:force_shownvalue_required

Näide: value_required

default_languagestring

Näide: 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' => 'et', '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": "et", "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": "et", "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" } }