API для партнёров › Аккаунт Получить справочники для платежей GET /api/crm/v2/payments.fieldsv2
operationId: payments.fields
Авторизация api-token + language + role
Ответы 200 404
object
status string обязательный
Значения: successerror
Пример: success
data 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
curl PHP JavaScript Python Копировать
curl -X GET 'https://foodsoul.ru/api/crm/v2/payments.fields' \
-H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
-H 'language: ru' \
-H 'role: partner' <?php
$client = new \GuzzleHttp\Client ();
$response = $client -> request ( 'GET' , 'https://foodsoul.ru/api/crm/v2/payments.fields' , [
'headers' => [
'Authorization' => 'Bearer fs_api_YOUR_TOKEN' ,
'language' => 'ru' ,
'role' => 'partner' ,
],
]);
$data = json_decode (( string ) $response -> getBody (), true ); const response = await fetch ( "https://foodsoul.ru/api/crm/v2/payments.fields" , {
method : "GET" ,
headers : {
"Authorization" : "Bearer fs_api_YOUR_TOKEN" ,
"language" : "ru" ,
"role" : "partner"
},
})
const data = await response . json () import requests
response = requests . request (
"GET" ,
"https://foodsoul.ru/api/crm/v2/payments.fields" ,
headers ={
"Authorization" : "Bearer fs_api_YOUR_TOKEN" ,
"language" : "ru" ,
"role" : "partner" ,
},
)
data = response . json () Ответ 200
{
"status" : "success" ,
"data" : {
"branch_id" : {
"value" : 8920 ,
"type" : "select" ,
"option" : [
{
"value" : 8920 ,
"name" : "Green Basket | Kaliningrad"
}
],
"mode" : "value_required"
}
}
} Запросы уходят на foodsoul.ru — хост этого портала, другой выбрать нельзя.