Отримати довідники для філій

GET/api/crm/v2/branches.fieldsv2

operationId: branches.fields

Повертає довідники для форми філії. Параметри chain_id та city_id обов’язкові.

Авторизація

api-token + language + role

Параметри запиту

chain_idintegerобов’язковий

Приклад: 7158

city_idintegerобов’язковий

Приклад: 7158

Відповіді

object

statusstringобов’язковий

Значення:successerror

Приклад: success

dataobject

Для створення — city_id (потрібен параметр city_id), для зміни — city (без параметра city_id)

branch_idobject (FilterSelectInteger)

valueinteger

Приклад: 8920

typestringобов’язковий

Приклад: select

optionarray of object

valueintegerобов’язковий

Приклад: 8920

namestringобов’язковий

Приклад: Green Basket | Kaliningrad

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

round_costs_modeobject (FilterEnum)

Фільтр-перерахування — плоский список значень перерахування

valuestring

Приклад: example

typestringобов’язковий

Приклад: select

optionarray of string

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

service_nameobject (FilterEnum)

Фільтр-перерахування — плоский список значень перерахування

valuestring

Приклад: example

typestringобов’язковий

Приклад: select

optionarray of string

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/branches.fields?chain_id=7158&city_id=7158', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'uk', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/branches.fields?chain_id=7158&city_id=7158", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "uk", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/branches.fields?chain_id=7158&city_id=7158", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "uk", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "branch_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "round_costs_mode": { "value": "example", "type": "select", "option": [ "string" ], "mode": "value_required" }, "service_name": { "value": "example", "type": "select", "option": [ "string" ], "mode": "value_required" } } }