Obtener la configuración básica

GET/api/crm/v2/base_settingsv2

operationId: baseSettings.default

Autorización

api-token + language + role

Parámetros de consulta

branch_idinteger

Ejemplo: 1

Respuestas

object

statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object

valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

default_imagestring

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

general_settingsobject

aboutstring

Texto HTML

Ejemplo: <b>About branch</b>

noticestring

Ejemplo: welcome

blockbooleanobligatorio

Ejemplo: true

cart_lead_timebooleanobligatorio

Ejemplo: true

cart_noticestring

Ejemplo: free delivery

order_message_minutesintegerobligatorio

Ejemplo: 10

order_message_permanent_clientbooleanobligatorio

Ejemplo: true

order_message_prepayment_orderbooleanobligatorio

Ejemplo: true

order_message_custom_texts_prepayment_and_not_workstring

Ejemplo: text

order_message_custom_texts_prepayment_and_workstring

Ejemplo: text

order_message_custom_texts_workstring

Ejemplo: text

order_message_custom_texts_not_workstring

Ejemplo: text

social_network_vkstring

Ejemplo: https://vk.com/id1

social_network_okstring

Ejemplo: https://ok.ru/username

social_network_tgstring

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

social_network_wastring

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

social_network_fbstring

Ejemplo: https://facebook.com/username

social_network_instring

Ejemplo: https://instagram.com/username

fieldsobject

senderarray of objectobligatorio

namestringobligatorio

Ejemplo: greeting_card

requiredbooleanobligatorio

Ejemplo: false

enabledbooleanobligatorio

Ejemplo: true

changeablebooleanobligatorio

Mostrar el interruptor de obligatoriedad; se muestra si el valor no es bool

Ejemplo: true

typestringobligatorio

Establecido por el sistema; la sucursal no puede modificarlo

Valores:integerstringphoneemailbool

Ejemplo: string

lengthinteger

Longitud máxima del valor. Establecido por el sistema; la sucursal solo puede modificarlo para campos con extendable.

Ejemplo: 200

extendableboolean

¿Se aplica length al campo?

Ejemplo: true

recipientarray of objectobligatorio

namestringobligatorio

Ejemplo: greeting_card

requiredbooleanobligatorio

Ejemplo: false

enabledbooleanobligatorio

Ejemplo: true

changeablebooleanobligatorio

Mostrar el interruptor de obligatoriedad; se muestra si el valor no es bool

Ejemplo: true

typestringobligatorio

Establecido por el sistema; la sucursal no puede modificarlo

Valores:integerstringphoneemailbool

Ejemplo: string

lengthinteger

Longitud máxima del valor. Establecido por el sistema; la sucursal solo puede modificarlo para campos con extendable.

Ejemplo: 200

extendableboolean

¿Se aplica length al campo?

Ejemplo: true

addressarray of objectobligatorio

namestringobligatorio

Ejemplo: greeting_card

requiredbooleanobligatorio

Ejemplo: false

enabledbooleanobligatorio

Ejemplo: true

changeablebooleanobligatorio

Mostrar el interruptor de obligatoriedad; se muestra si el valor no es bool

Ejemplo: true

typestringobligatorio

Establecido por el sistema; la sucursal no puede modificarlo

Valores:integerstringphoneemailbool

Ejemplo: string

lengthinteger

Longitud máxima del valor. Establecido por el sistema; la sucursal solo puede modificarlo para campos con extendable.

Ejemplo: 200

extendableboolean

¿Se aplica length al campo?

Ejemplo: true

additionalarray of objectobligatorio

namestringobligatorio

Ejemplo: greeting_card

requiredbooleanobligatorio

Ejemplo: false

enabledbooleanobligatorio

Ejemplo: true

changeablebooleanobligatorio

Mostrar el interruptor de obligatoriedad; se muestra si el valor no es bool

Ejemplo: true

typestringobligatorio

Establecido por el sistema; la sucursal no puede modificarlo

Valores:integerstringphoneemailbool

Ejemplo: string

lengthinteger

Longitud máxima del valor. Establecido por el sistema; la sucursal solo puede modificarlo para campos con extendable.

Ejemplo: 200

extendableboolean

¿Se aplica length al campo?

Ejemplo: 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' => 'es', '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": "es", "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": "es", "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 } ] } } }