Kurye referanslarını alın

GET/api/crm/v2/couriers_list.fieldsv2

operationId: couriersList.fields

Yetkilendirme

api-token + language + role

Sorgu parametreleri

branch_idintegerzorunlu

Örnek: 1

Yanıtlar

object

statusstringzorunlu

Değerler:successerror

Örnek: success

dataobject

district_idobject (FilterSelectInteger)

valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object

valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

account_idinteger

Seçilen branch_id için hesap kimliği

Örnek: 3922

firm_user_idobject

Hesapta operatör özelliğine ve kurye ayarlarına bağlı tüm kullanıcılar

typestring

Örnek: select

optionarray of object

valueinteger

Örnek: 825

namestring

Örnek: user@fs.pro

has_operator_settingsboolean

Örnek: false

has_courier_settingsboolean

Örnek: false

distribution_methodobject (FilterEnum)

Filtre-enum — düz enum değerleri listesi

valuestring

Örnek: example

typestringzorunlu

Örnek: select

optionarray of string

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

timezoneobject (FilterSelect)

valuestring

Örnek: example

typestringzorunlu

Örnek: select

optionarray of object

valuestringzorunlu

Örnek: example

namestringzorunlu

Örnek: All

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

default_languagestring

Örnek: 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' => 'tr', '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": "tr", "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": "tr", "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" } }