Отримати базові налаштування

GET/api/crm/v2/base_settingsv2

operationId: baseSettings.default

Авторизація

api-token + language + role

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

branch_idinteger

Приклад: 1

Відповіді

object

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

Значення:successerror

Приклад: success

dataobject

filtersobject

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

default_imagestring

Приклад: https://cdn.foodsoul.test/zones/ru/chains/7160/images/main/79dc3bfc72d9cb6176a13a5e9a17d0aa.png?v1745397512

general_settingsobject

aboutstring

HTML-текст

Приклад: <b>About branch</b>

noticestring

Приклад: welcome

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

Приклад: true

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

Приклад: true

cart_noticestring

Приклад: free delivery

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

Приклад: 10

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

Приклад: true

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

Приклад: true

order_message_custom_texts_prepayment_and_not_workstring

Приклад: text

order_message_custom_texts_prepayment_and_workstring

Приклад: text

order_message_custom_texts_workstring

Приклад: text

order_message_custom_texts_not_workstring

Приклад: text

social_network_vkstring

Приклад: https://vk.com/id1

social_network_okstring

Приклад: https://ok.ru/username

social_network_tgstring

Приклад: https://t.me/@username

social_network_wastring

Приклад: https://chat.whatsapp.com/@username

social_network_fbstring

Приклад: https://facebook.com/username

social_network_instring

Приклад: https://instagram.com/username

fieldsobject

senderarray of objectобов’язковий

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

Приклад: greeting_card

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

Приклад: false

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

Приклад: true

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

Показувати перемикач обов’язковості; відображається, якщо значення не bool

Приклад: true

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

Встановлюється системою; філія не може його змінити

Значення:integerstringphoneemailbool

Приклад: string

lengthinteger

Максимальна довжина значення. Встановлюється системою; філія може змінити лише для поля з extendable.

Приклад: 200

extendableboolean

Чи застосовується length до поля

Приклад: true

recipientarray of objectобов’язковий

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

Приклад: greeting_card

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

Приклад: false

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

Приклад: true

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

Показувати перемикач обов’язковості; відображається, якщо значення не bool

Приклад: true

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

Встановлюється системою; філія не може його змінити

Значення:integerstringphoneemailbool

Приклад: string

lengthinteger

Максимальна довжина значення. Встановлюється системою; філія може змінити лише для поля з extendable.

Приклад: 200

extendableboolean

Чи застосовується length до поля

Приклад: true

addressarray of objectобов’язковий

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

Приклад: greeting_card

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

Приклад: false

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

Приклад: true

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

Показувати перемикач обов’язковості; відображається, якщо значення не bool

Приклад: true

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

Встановлюється системою; філія не може його змінити

Значення:integerstringphoneemailbool

Приклад: string

lengthinteger

Максимальна довжина значення. Встановлюється системою; філія може змінити лише для поля з extendable.

Приклад: 200

extendableboolean

Чи застосовується length до поля

Приклад: true

additionalarray of objectобов’язковий

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

Приклад: greeting_card

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

Приклад: false

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

Приклад: true

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

Показувати перемикач обов’язковості; відображається, якщо значення не bool

Приклад: true

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

Встановлюється системою; філія не може його змінити

Значення:integerstringphoneemailbool

Приклад: string

lengthinteger

Максимальна довжина значення. Встановлюється системою; філія може змінити лише для поля з extendable.

Приклад: 200

extendableboolean

Чи застосовується length до поля

Приклад: true

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/base_settings', [ '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/base_settings", { 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/base_settings", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "uk", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "filters": { "branch_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" } }, "default_image": "https://cdn.foodsoul.test/zones/ru/chains/7160/images/main/79dc3bfc72d9cb6176a13a5e9a17d0aa.png?v1745397512", "general_settings": { "about": "<b>About branch</b>", "notice": "welcome", "block": true, "cart_lead_time": true, "cart_notice": "free delivery", "order_message_minutes": 10, "order_message_permanent_client": true, "order_message_prepayment_order": true, "order_message_custom_texts_prepayment_and_not_work": "text", "order_message_custom_texts_prepayment_and_work": "text", "order_message_custom_texts_work": "text", "order_message_custom_texts_not_work": "text", "social_network_vk": "https://vk.com/id1", "social_network_ok": "https://ok.ru/username", "social_network_tg": "https://t.me/@username", "social_network_wa": "https://chat.whatsapp.com/@username", "social_network_fb": "https://facebook.com/username", "social_network_in": "https://instagram.com/username" }, "fields": { "sender": [ { "name": "greeting_card", "required": false, "enabled": true, "changeable": true, "type": "string", "length": 200, "extendable": true } ], "recipient": [ { "name": "greeting_card", "required": false, "enabled": true, "changeable": true, "type": "string", "length": 200, "extendable": true } ], "address": [ { "name": "greeting_card", "required": false, "enabled": true, "changeable": true, "type": "string", "length": 200, "extendable": true } ], "additional": [ { "name": "greeting_card", "required": false, "enabled": true, "changeable": true, "type": "string", "length": 200, "extendable": true } ] } } }