Získat základní nastavení

GET/api/crm/v2/base_settingsv2

operationId: baseSettings.default

Autorizace

api-token + language + role

Parametry dotazu

branch_idinteger

Příklad: 1

Odpovědi

object

statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object

valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

default_imagestring

Příklad: https://cdn.foodsoul.test/zones/ru/chains/7160/images/main/79dc3bfc72d9cb6176a13a5e9a17d0aa.png?v1745397512

general_settingsobject

aboutstring

HTML-text

Příklad: <b>About branch</b>

noticestring

Příklad: welcome

blockbooleanpovinné

Příklad: true

cart_lead_timebooleanpovinné

Příklad: true

cart_noticestring

Příklad: free delivery

order_message_minutesintegerpovinné

Příklad: 10

order_message_permanent_clientbooleanpovinné

Příklad: true

order_message_prepayment_orderbooleanpovinné

Příklad: true

order_message_custom_texts_prepayment_and_not_workstring

Příklad: text

order_message_custom_texts_prepayment_and_workstring

Příklad: text

order_message_custom_texts_workstring

Příklad: text

order_message_custom_texts_not_workstring

Příklad: text

social_network_vkstring

Příklad: https://vk.com/id1

social_network_okstring

Příklad: https://ok.ru/username

social_network_tgstring

Příklad: https://t.me/@username

social_network_wastring

Příklad: https://chat.whatsapp.com/@username

social_network_fbstring

Příklad: https://facebook.com/username

social_network_instring

Příklad: https://instagram.com/username

fieldsobject

senderarray of objectpovinné

namestringpovinné

Příklad: greeting_card

requiredbooleanpovinné

Příklad: false

enabledbooleanpovinné

Příklad: true

changeablebooleanpovinné

Zobrazit přepínač povinnosti; zobrazuje se, pokud hodnota není bool

Příklad: true

typestringpovinné

Je nastaven systémem; pobočka jej nemůže změnit

Hodnoty:integerstringphoneemailbool

Příklad: string

lengthinteger

Maximální délka hodnoty. Nastavuje systém; pobočka ji může změnit pouze u pole s extendable.

Příklad: 200

extendableboolean

Platí length pro pole

Příklad: true

recipientarray of objectpovinné

namestringpovinné

Příklad: greeting_card

requiredbooleanpovinné

Příklad: false

enabledbooleanpovinné

Příklad: true

changeablebooleanpovinné

Zobrazit přepínač povinnosti; zobrazuje se, pokud hodnota není bool

Příklad: true

typestringpovinné

Je nastaven systémem; pobočka jej nemůže změnit

Hodnoty:integerstringphoneemailbool

Příklad: string

lengthinteger

Maximální délka hodnoty. Nastavuje systém; pobočka ji může změnit pouze u pole s extendable.

Příklad: 200

extendableboolean

Platí length pro pole

Příklad: true

addressarray of objectpovinné

namestringpovinné

Příklad: greeting_card

requiredbooleanpovinné

Příklad: false

enabledbooleanpovinné

Příklad: true

changeablebooleanpovinné

Zobrazit přepínač povinnosti; zobrazuje se, pokud hodnota není bool

Příklad: true

typestringpovinné

Je nastaven systémem; pobočka jej nemůže změnit

Hodnoty:integerstringphoneemailbool

Příklad: string

lengthinteger

Maximální délka hodnoty. Nastavuje systém; pobočka ji může změnit pouze u pole s extendable.

Příklad: 200

extendableboolean

Platí length pro pole

Příklad: true

additionalarray of objectpovinné

namestringpovinné

Příklad: greeting_card

requiredbooleanpovinné

Příklad: false

enabledbooleanpovinné

Příklad: true

changeablebooleanpovinné

Zobrazit přepínač povinnosti; zobrazuje se, pokud hodnota není bool

Příklad: true

typestringpovinné

Je nastaven systémem; pobočka jej nemůže změnit

Hodnoty:integerstringphoneemailbool

Příklad: string

lengthinteger

Maximální délka hodnoty. Nastavuje systém; pobočka ji může změnit pouze u pole s extendable.

Příklad: 200

extendableboolean

Platí length pro pole

Příklad: 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' => 'cs', '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": "cs", "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": "cs", "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 } ] } } }