Ottenere le impostazioni di base

GET/api/crm/v2/base_settingsv2

operationId: baseSettings.default

Autorizzazione

api-token + language + role

Parametri della richiesta

branch_idinteger

Esempio: 1

Risposte

object

statusstringobbligatorio

Valori:successerror

Esempio: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object

valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

default_imagestring

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

general_settingsobject

aboutstring

Testo HTML

Esempio: <b>About branch</b>

noticestring

Esempio: welcome

blockbooleanobbligatorio

Esempio: true

cart_lead_timebooleanobbligatorio

Esempio: true

cart_noticestring

Esempio: free delivery

order_message_minutesintegerobbligatorio

Esempio: 10

order_message_permanent_clientbooleanobbligatorio

Esempio: true

order_message_prepayment_orderbooleanobbligatorio

Esempio: true

order_message_custom_texts_prepayment_and_not_workstring

Esempio: text

order_message_custom_texts_prepayment_and_workstring

Esempio: text

order_message_custom_texts_workstring

Esempio: text

order_message_custom_texts_not_workstring

Esempio: text

social_network_vkstring

Esempio: https://vk.com/id1

social_network_okstring

Esempio: https://ok.ru/username

social_network_tgstring

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

social_network_wastring

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

social_network_fbstring

Esempio: https://facebook.com/username

social_network_instring

Esempio: https://instagram.com/username

fieldsobject

senderarray of objectobbligatorio

namestringobbligatorio

Esempio: greeting_card

requiredbooleanobbligatorio

Esempio: false

enabledbooleanobbligatorio

Esempio: true

changeablebooleanobbligatorio

Mostrare l'interruttore di obbligatorietà; viene mostrato se il valore non è bool

Esempio: true

typestringobbligatorio

Impostato dal sistema; la filiale non può modificarlo

Valori:integerstringphoneemailbool

Esempio: string

lengthinteger

Lunghezza massima del valore. Impostato dal sistema; la filiale può modificarlo solo per i campi con extendable.

Esempio: 200

extendableboolean

length si applica al campo

Esempio: true

recipientarray of objectobbligatorio

namestringobbligatorio

Esempio: greeting_card

requiredbooleanobbligatorio

Esempio: false

enabledbooleanobbligatorio

Esempio: true

changeablebooleanobbligatorio

Mostrare l'interruttore di obbligatorietà; viene mostrato se il valore non è bool

Esempio: true

typestringobbligatorio

Impostato dal sistema; la filiale non può modificarlo

Valori:integerstringphoneemailbool

Esempio: string

lengthinteger

Lunghezza massima del valore. Impostato dal sistema; la filiale può modificarlo solo per i campi con extendable.

Esempio: 200

extendableboolean

length si applica al campo

Esempio: true

addressarray of objectobbligatorio

namestringobbligatorio

Esempio: greeting_card

requiredbooleanobbligatorio

Esempio: false

enabledbooleanobbligatorio

Esempio: true

changeablebooleanobbligatorio

Mostrare l'interruttore di obbligatorietà; viene mostrato se il valore non è bool

Esempio: true

typestringobbligatorio

Impostato dal sistema; la filiale non può modificarlo

Valori:integerstringphoneemailbool

Esempio: string

lengthinteger

Lunghezza massima del valore. Impostato dal sistema; la filiale può modificarlo solo per i campi con extendable.

Esempio: 200

extendableboolean

length si applica al campo

Esempio: true

additionalarray of objectobbligatorio

namestringobbligatorio

Esempio: greeting_card

requiredbooleanobbligatorio

Esempio: false

enabledbooleanobbligatorio

Esempio: true

changeablebooleanobbligatorio

Mostrare l'interruttore di obbligatorietà; viene mostrato se il valore non è bool

Esempio: true

typestringobbligatorio

Impostato dal sistema; la filiale non può modificarlo

Valori:integerstringphoneemailbool

Esempio: string

lengthinteger

Lunghezza massima del valore. Impostato dal sistema; la filiale può modificarlo solo per i campi con extendable.

Esempio: 200

extendableboolean

length si applica al campo

Esempio: 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' => 'it', '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": "it", "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": "it", "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 } ] } } }