Серіктестерге арналған API › Параметрлер Курьерлердің баптаулар тізімін алу GET /api/crm/v2/couriers_listv2
operationId: couriersList.default
Авторизация api-token + language + role
Сұраныс параметрлері branch_id integer міндетті
Мысал: 1
Жауаптар 200
object
status string міндетті
Мәндер: successerror
Мысал: success
data object
filters object
branch_id object (FilterSelectInteger)
type string міндетті
Мысал: select
option array of object
value integer міндетті
Мысал: 8920
name string міндетті
Мысал: Green Basket | Kaliningrad
mode string (FilterMode)
Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.
Мәндер: force_shownvalue_required
Мысал: value_required
settings object
distribution_method string міндетті
Мәндер: manuallyautomatically
Мысал: manually
independence boolean міндетті
Мысал: true
list array of object
id integer міндетті
Мысал: 1
name string міндетті
Мысал: example
firm_user_id integer
Мысал: 1
districts_ids array of integer
curl PHP JavaScript Python Көшіру
curl -X GET 'https://foodsoul.pro/api/crm/v2/couriers_list?branch_id=1' \
-H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
-H 'language: kk' \
-H 'role: partner' <?php
$client = new \GuzzleHttp\Client ();
$response = $client -> request ( 'GET' , 'https://foodsoul.pro/api/crm/v2/couriers_list?branch_id=1' , [
'headers' => [
'Authorization' => 'Bearer fs_api_YOUR_TOKEN' ,
'language' => 'kk' ,
'role' => 'partner' ,
],
]);
$data = json_decode (( string ) $response -> getBody (), true ); const response = await fetch ( "https://foodsoul.pro/api/crm/v2/couriers_list?branch_id=1" , {
method : "GET" ,
headers : {
"Authorization" : "Bearer fs_api_YOUR_TOKEN" ,
"language" : "kk" ,
"role" : "partner"
},
})
const data = await response . json () import requests
response = requests . request (
"GET" ,
"https://foodsoul.pro/api/crm/v2/couriers_list?branch_id=1" ,
headers ={
"Authorization" : "Bearer fs_api_YOUR_TOKEN" ,
"language" : "kk" ,
"role" : "partner" ,
},
)
data = response . json () Жауап 200
{
"status" : "success" ,
"data" : {
"filters" : {
"branch_id" : {
"value" : 8920 ,
"type" : "select" ,
"option" : [
{
"value" : 8920 ,
"name" : "Green Basket | Kaliningrad"
}
],
"mode" : "value_required"
}
},
"settings" : {
"distribution_method" : "manually" ,
"independence" : true
},
"list" : [
{
"id" : 1 ,
"name" : "example" ,
"firm_user_id" : 1 ,
"districts_ids" : [
1
]
}
]
}
} Сұраныстар foodsoul.pro — осы порталдың хостына жіберіледі, басқа хостты таңдау мүмкін емес.