Получить настройки мобильного приложения

GET/api/crm/v2/mobile_apps_settingsv2

operationId: mobileAppsSettings.default

Авторизация

api-token + language + role

Параметры запроса

branch_idinteger

Пример: 1

Ответы

object

statusstringобязательный

Значения:successerror

Пример: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Пример: 8920

typestringобязательный

Пример: select

optionarray of object

valueintegerобязательный

Пример: 8920

namestringобязательный

Пример: Green Basket | Kaliningrad

modestring (FilterMode)

Как интерфейс обрабатывает фильтр; у обычного фильтра mode нет. force_shown — всегда показан, скрыть нельзя. value_required — точка входа в раздел: всегда показан, не имеет пустого значения (пока значение не выбрано, список пуст; варианта «все» нет), общий сброс его не очищает.

Значения:force_shownvalue_required

Пример: value_required

check_access_for_force_update_iosboolean

Пример: true

settingsobject

is_parent_chainbooleanобязательный

Пример: true

mobile_apps_titlestring

Пример: Pizza

mobile_apps_subtitlestring

Пример: Pizza

mobile_apps_icon_namestring

Пример: icon1

mobile_apps_keywordsstring

Пример: delivery,online,order,pizza,sushi,rolls,snacks,salads,sets

mobile_apps_short_descriptionstring

Пример: We are here to make your day better

mobile_apps_full_descriptionstring

Пример: Use the application to order food: pick your dishes, pay online and get them delivered to your door in a few clicks

update_metadataboolean

Пример: true

update_screenshotsboolean

Пример: true

ios_force_update_enabledboolean

Пример: true

marketer_reviewedboolean

Пример: true

auto_changebooleanобязательный

Пример: true

theme_defaultstring (ThemeDefault)

Возможные значения: light, bright, blue, dark

Значения:lightbrightbluedark

Пример: light

theme_daystring

Значения:lightbright

Пример: light

theme_nightstring

Значения:bluedark

Пример: dark

templatestring

Значения:side_menubottom_menu

bottom_menu_icons_and_titles_boldboolean

Пример: false

bottom_menu_titles_showboolean

Пример: false

side_menu_icons_and_titles_boldboolean

Пример: false

side_menu_background_colorstring

Пример: E74C3C

side_menu_icons_and_titles_colorstring

Пример: FFFFFF

main_colorstring

Пример: 607D8B

catalog_items_image_ratiostring

Значения:5:230:191:14:316:9

Пример: 5:2

catalog_items_in_two_columnsboolean

Пример: true

catalog_items_max_rows_descriptioninteger

Пример: 99

catalog_horizontal_categoriesboolean

Пример: false

catalog_items_animation_on_tap_enabledboolean

Пример: false

special_offers_animation_on_tap_enabledboolean

Пример: false

designer_reviewedboolean

Пример: true

is_read_only_modebooleanобязательный

Пример: true

radius_blurinteger

Только если template = side_menu

Пример: 0

background_imagestring

Пример: https://cdn.foodsoul.test/backgrounds/mobile_apps/0f8bb6781f04a1cb0e231bd06356b86c.jpg

logostring

Пример: https://cdn.foodsoul.test/zones/ru/chains/7160/images/themes/mobile_apps/87c8980728da83d80e4f8a5f7dfa67c4.png?v1748430033

google_play_metadatastring

Пример: https://cdn.foodsoul.test/zones/ru/chains/7160/images/meta_data/google_play.png?v1748430936

ios_iconstring

Пример: https://cdn.foodsoul.test/zones/ru/chains/7160/images/icons/ios.png?v1748430936

watch_iconstring

Пример: https://cdn.foodsoul.test/zones/ru/chains/7160/images/icons/watch.png?v1748430936

android_iconstring

Пример: https://cdn.foodsoul.test/zones/ru/chains/7160/images/icons/android.png?v1748430936

mobile_apps_title_status_of_checkstringобязательный

Значения:approvedtakenverification

Пример: approved

apps_noticestring

Пример: text

special_offers_separate_sectionboolean

Пример: true

special_offers_title_in_catalogboolean

Пример: true

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/mobile_apps_settings', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'ru', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/mobile_apps_settings", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/mobile_apps_settings", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "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" } }, "check_access_for_force_update_ios": true, "settings": { "is_parent_chain": true, "mobile_apps_title": "Pizza", "mobile_apps_subtitle": "Pizza", "mobile_apps_icon_name": "icon1", "mobile_apps_keywords": "delivery,online,order,pizza,sushi,rolls,snacks,salads,sets", "mobile_apps_short_description": "We are here to make your day better", "mobile_apps_full_description": "Use the application to order food: pick your dishes, pay online and get them delivered to your door in a few clicks", "update_metadata": true, "update_screenshots": true, "ios_force_update_enabled": true, "marketer_reviewed": true, "auto_change": true, "theme_default": "light", "theme_day": "light", "theme_night": "dark", "template": "side_menu", "bottom_menu_icons_and_titles_bold": false, "bottom_menu_titles_show": false, "side_menu_icons_and_titles_bold": false, "side_menu_background_color": "E74C3C", "side_menu_icons_and_titles_color": "FFFFFF", "main_color": "607D8B", "catalog_items_image_ratio": "5:2", "catalog_items_in_two_columns": true, "catalog_items_max_rows_description": 99, "catalog_horizontal_categories": false, "catalog_items_animation_on_tap_enabled": false, "special_offers_animation_on_tap_enabled": false, "designer_reviewed": true, "is_read_only_mode": true, "radius_blur": 0, "background_image": "https://cdn.foodsoul.test/backgrounds/mobile_apps/0f8bb6781f04a1cb0e231bd06356b86c.jpg", "logo": "https://cdn.foodsoul.test/zones/ru/chains/7160/images/themes/mobile_apps/87c8980728da83d80e4f8a5f7dfa67c4.png?v1748430033", "google_play_metadata": "https://cdn.foodsoul.test/zones/ru/chains/7160/images/meta_data/google_play.png?v1748430936", "ios_icon": "https://cdn.foodsoul.test/zones/ru/chains/7160/images/icons/ios.png?v1748430936", "watch_icon": "https://cdn.foodsoul.test/zones/ru/chains/7160/images/icons/watch.png?v1748430936", "android_icon": "https://cdn.foodsoul.test/zones/ru/chains/7160/images/icons/android.png?v1748430936", "mobile_apps_title_status_of_check": "approved", "apps_notice": "text", "special_offers_separate_section": true, "special_offers_title_in_catalog": true } } }