Obter configurações básicas

GET/api/crm/v2/base_settingsv2

operationId: baseSettings.default

Autorização

api-token + language + role

Parâmetros de consulta

branch_idinteger

Exemplo: 1

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object

valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

default_imagestring

Exemplo: https://cdn.foodsoul.test/zones/ru/chains/7160/images/main/79dc3bfc72d9cb6176a13a5e9a17d0aa.png?v1745397512

general_settingsobject

aboutstring

Texto HTML

Exemplo: <b>About branch</b>

noticestring

Exemplo: welcome

blockbooleanobrigatório

Exemplo: true

cart_lead_timebooleanobrigatório

Exemplo: true

cart_noticestring

Exemplo: free delivery

order_message_minutesintegerobrigatório

Exemplo: 10

order_message_permanent_clientbooleanobrigatório

Exemplo: true

order_message_prepayment_orderbooleanobrigatório

Exemplo: true

order_message_custom_texts_prepayment_and_not_workstring

Exemplo: text

order_message_custom_texts_prepayment_and_workstring

Exemplo: text

order_message_custom_texts_workstring

Exemplo: text

order_message_custom_texts_not_workstring

Exemplo: text

social_network_vkstring

Exemplo: https://vk.com/id1

social_network_okstring

Exemplo: https://ok.ru/username

social_network_tgstring

Exemplo: https://t.me/@username

social_network_wastring

Exemplo: https://chat.whatsapp.com/@username

social_network_fbstring

Exemplo: https://facebook.com/username

social_network_instring

Exemplo: https://instagram.com/username

fieldsobject

senderarray of objectobrigatório

namestringobrigatório

Exemplo: greeting_card

requiredbooleanobrigatório

Exemplo: false

enabledbooleanobrigatório

Exemplo: true

changeablebooleanobrigatório

Exibir o alternador de obrigatoriedade; exibido se o valor não for bool

Exemplo: true

typestringobrigatório

Definido pelo sistema; a filial não pode alterá-lo

Valores:integerstringphoneemailbool

Exemplo: string

lengthinteger

Comprimento máximo do valor. Definido pelo sistema; a filial pode alterá-lo apenas para campos com extendable.

Exemplo: 200

extendableboolean

length se aplica ao campo

Exemplo: true

recipientarray of objectobrigatório

namestringobrigatório

Exemplo: greeting_card

requiredbooleanobrigatório

Exemplo: false

enabledbooleanobrigatório

Exemplo: true

changeablebooleanobrigatório

Exibir o alternador de obrigatoriedade; exibido se o valor não for bool

Exemplo: true

typestringobrigatório

Definido pelo sistema; a filial não pode alterá-lo

Valores:integerstringphoneemailbool

Exemplo: string

lengthinteger

Comprimento máximo do valor. Definido pelo sistema; a filial pode alterá-lo apenas para campos com extendable.

Exemplo: 200

extendableboolean

length se aplica ao campo

Exemplo: true

addressarray of objectobrigatório

namestringobrigatório

Exemplo: greeting_card

requiredbooleanobrigatório

Exemplo: false

enabledbooleanobrigatório

Exemplo: true

changeablebooleanobrigatório

Exibir o alternador de obrigatoriedade; exibido se o valor não for bool

Exemplo: true

typestringobrigatório

Definido pelo sistema; a filial não pode alterá-lo

Valores:integerstringphoneemailbool

Exemplo: string

lengthinteger

Comprimento máximo do valor. Definido pelo sistema; a filial pode alterá-lo apenas para campos com extendable.

Exemplo: 200

extendableboolean

length se aplica ao campo

Exemplo: true

additionalarray of objectobrigatório

namestringobrigatório

Exemplo: greeting_card

requiredbooleanobrigatório

Exemplo: false

enabledbooleanobrigatório

Exemplo: true

changeablebooleanobrigatório

Exibir o alternador de obrigatoriedade; exibido se o valor não for bool

Exemplo: true

typestringobrigatório

Definido pelo sistema; a filial não pode alterá-lo

Valores:integerstringphoneemailbool

Exemplo: string

lengthinteger

Comprimento máximo do valor. Definido pelo sistema; a filial pode alterá-lo apenas para campos com extendable.

Exemplo: 200

extendableboolean

length se aplica ao campo

Exemplo: 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' => 'pt', '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": "pt", "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": "pt", "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 } ] } } }