Obtenir les paramètres de base

GET/api/crm/v2/base_settingsv2

operationId: baseSettings.default

Autorisation

api-token + language + role

Paramètres de requête

branch_idinteger

Exemple: 1

Réponses

object

statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object

valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

default_imagestring

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

general_settingsobject

aboutstring

Texte HTML

Exemple: <b>About branch</b>

noticestring

Exemple: welcome

blockbooleanobligatoire

Exemple: true

cart_lead_timebooleanobligatoire

Exemple: true

cart_noticestring

Exemple: free delivery

order_message_minutesintegerobligatoire

Exemple: 10

order_message_permanent_clientbooleanobligatoire

Exemple: true

order_message_prepayment_orderbooleanobligatoire

Exemple: true

order_message_custom_texts_prepayment_and_not_workstring

Exemple: text

order_message_custom_texts_prepayment_and_workstring

Exemple: text

order_message_custom_texts_workstring

Exemple: text

order_message_custom_texts_not_workstring

Exemple: text

social_network_vkstring

Exemple: https://vk.com/id1

social_network_okstring

Exemple: https://ok.ru/username

social_network_tgstring

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

social_network_wastring

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

social_network_fbstring

Exemple: https://facebook.com/username

social_network_instring

Exemple: https://instagram.com/username

fieldsobject

senderarray of objectobligatoire

namestringobligatoire

Exemple: greeting_card

requiredbooleanobligatoire

Exemple: false

enabledbooleanobligatoire

Exemple: true

changeablebooleanobligatoire

Afficher le commutateur d'obligation ; affiché si la valeur n'est pas bool

Exemple: true

typestringobligatoire

Défini par le système ; la succursale ne peut pas le modifier

Valeurs:integerstringphoneemailbool

Exemple: string

lengthinteger

Longueur maximale de la valeur. Définie par le système ; la succursale peut la modifier uniquement pour un champ avec extendable.

Exemple: 200

extendableboolean

Le champ length s'applique-t-il au champ

Exemple: true

recipientarray of objectobligatoire

namestringobligatoire

Exemple: greeting_card

requiredbooleanobligatoire

Exemple: false

enabledbooleanobligatoire

Exemple: true

changeablebooleanobligatoire

Afficher le commutateur d'obligation ; affiché si la valeur n'est pas bool

Exemple: true

typestringobligatoire

Défini par le système ; la succursale ne peut pas le modifier

Valeurs:integerstringphoneemailbool

Exemple: string

lengthinteger

Longueur maximale de la valeur. Définie par le système ; la succursale peut la modifier uniquement pour un champ avec extendable.

Exemple: 200

extendableboolean

Le champ length s'applique-t-il au champ

Exemple: true

addressarray of objectobligatoire

namestringobligatoire

Exemple: greeting_card

requiredbooleanobligatoire

Exemple: false

enabledbooleanobligatoire

Exemple: true

changeablebooleanobligatoire

Afficher le commutateur d'obligation ; affiché si la valeur n'est pas bool

Exemple: true

typestringobligatoire

Défini par le système ; la succursale ne peut pas le modifier

Valeurs:integerstringphoneemailbool

Exemple: string

lengthinteger

Longueur maximale de la valeur. Définie par le système ; la succursale peut la modifier uniquement pour un champ avec extendable.

Exemple: 200

extendableboolean

Le champ length s'applique-t-il au champ

Exemple: true

additionalarray of objectobligatoire

namestringobligatoire

Exemple: greeting_card

requiredbooleanobligatoire

Exemple: false

enabledbooleanobligatoire

Exemple: true

changeablebooleanobligatoire

Afficher le commutateur d'obligation ; affiché si la valeur n'est pas bool

Exemple: true

typestringobligatoire

Défini par le système ; la succursale ne peut pas le modifier

Valeurs:integerstringphoneemailbool

Exemple: string

lengthinteger

Longueur maximale de la valeur. Définie par le système ; la succursale peut la modifier uniquement pour un champ avec extendable.

Exemple: 200

extendableboolean

Le champ length s'applique-t-il au champ

Exemple: 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' => 'fr', '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": "fr", "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": "fr", "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 } ] } } }