Получить основные настройки

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.ru/api/crm/v2/base_settings', [ '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/base_settings", { 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/base_settings", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "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 } ] } } }