Отримати налаштування мобільного додатку

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' => 'uk', '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": "uk", "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": "uk", "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 } } }