Haupteinstellungen abrufen

GET/api/crm/v2/base_settingsv2

operationId: baseSettings.default

Autorisierung

api-token + language + role

Abfrageparameter

branch_idinteger

Beispiel: 1

Antworten

object

statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

default_imagestring

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

general_settingsobject

aboutstring

HTML-Text

Beispiel: <b>About branch</b>

noticestring

Beispiel: welcome

blockbooleanerforderlich

Beispiel: true

cart_lead_timebooleanerforderlich

Beispiel: true

cart_noticestring

Beispiel: free delivery

order_message_minutesintegererforderlich

Beispiel: 10

order_message_permanent_clientbooleanerforderlich

Beispiel: true

order_message_prepayment_orderbooleanerforderlich

Beispiel: true

order_message_custom_texts_prepayment_and_not_workstring

Beispiel: text

order_message_custom_texts_prepayment_and_workstring

Beispiel: text

order_message_custom_texts_workstring

Beispiel: text

order_message_custom_texts_not_workstring

Beispiel: text

social_network_vkstring

Beispiel: https://vk.com/id1

social_network_okstring

Beispiel: https://ok.ru/username

social_network_tgstring

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

social_network_wastring

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

social_network_fbstring

Beispiel: https://facebook.com/username

social_network_instring

Beispiel: https://instagram.com/username

fieldsobject

senderarray of objecterforderlich

namestringerforderlich

Beispiel: greeting_card

requiredbooleanerforderlich

Beispiel: false

enabledbooleanerforderlich

Beispiel: true

changeablebooleanerforderlich

Ob Soll-Pflicht-Umschalter angezeigt wird; wird angezeigt, wenn der Wert nicht bool ist

Beispiel: true

typestringerforderlich

Vom System festgelegt; die Filiale kann ihn nicht ändern

Werte:integerstringphoneemailbool

Beispiel: string

lengthinteger

Maximale Wertlänge. Vom System festgelegt; eine Filiale kann sie nur für ein Feld mit extendable ändern.

Beispiel: 200

extendableboolean

Gilt length für das Feld?

Beispiel: true

recipientarray of objecterforderlich

namestringerforderlich

Beispiel: greeting_card

requiredbooleanerforderlich

Beispiel: false

enabledbooleanerforderlich

Beispiel: true

changeablebooleanerforderlich

Ob Soll-Pflicht-Umschalter angezeigt wird; wird angezeigt, wenn der Wert nicht bool ist

Beispiel: true

typestringerforderlich

Vom System festgelegt; die Filiale kann ihn nicht ändern

Werte:integerstringphoneemailbool

Beispiel: string

lengthinteger

Maximale Wertlänge. Vom System festgelegt; eine Filiale kann sie nur für ein Feld mit extendable ändern.

Beispiel: 200

extendableboolean

Gilt length für das Feld?

Beispiel: true

addressarray of objecterforderlich

namestringerforderlich

Beispiel: greeting_card

requiredbooleanerforderlich

Beispiel: false

enabledbooleanerforderlich

Beispiel: true

changeablebooleanerforderlich

Ob Soll-Pflicht-Umschalter angezeigt wird; wird angezeigt, wenn der Wert nicht bool ist

Beispiel: true

typestringerforderlich

Vom System festgelegt; die Filiale kann ihn nicht ändern

Werte:integerstringphoneemailbool

Beispiel: string

lengthinteger

Maximale Wertlänge. Vom System festgelegt; eine Filiale kann sie nur für ein Feld mit extendable ändern.

Beispiel: 200

extendableboolean

Gilt length für das Feld?

Beispiel: true

additionalarray of objecterforderlich

namestringerforderlich

Beispiel: greeting_card

requiredbooleanerforderlich

Beispiel: false

enabledbooleanerforderlich

Beispiel: true

changeablebooleanerforderlich

Ob Soll-Pflicht-Umschalter angezeigt wird; wird angezeigt, wenn der Wert nicht bool ist

Beispiel: true

typestringerforderlich

Vom System festgelegt; die Filiale kann ihn nicht ändern

Werte:integerstringphoneemailbool

Beispiel: string

lengthinteger

Maximale Wertlänge. Vom System festgelegt; eine Filiale kann sie nur für ein Feld mit extendable ändern.

Beispiel: 200

extendableboolean

Gilt length für das Feld?

Beispiel: 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' => 'de', '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": "de", "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": "de", "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 } ] } } }