Home Screen

action

Setting: action

Doc Status: Private

Activity Spinner Color

Setting: activity_color

Set the color of the Activity spinner, which is displayed when the app is connecting to the server to send or receive data.
This setting is on the General Setting tab on the App Settings page.
Remember, all settings are role based so you have to change it for each role.

Doc Status: Public

activity_iap_message

Setting: activity_iap_message

Doc Status: No Doc

activity_iap_no

Setting: activity_iap_no

Doc Status: No Doc

activity_iap_ok

Setting: activity_iap_ok

Doc Status: No Doc

activity_iap_title

Setting: activity_iap_title

Doc Status: No Doc

activity_marker

Setting: activity_marker

Doc Status: No Doc

activity_use_color_bar_for_in_progress

Setting: activity_use_color_bar_for_in_progress

Doc Status: No Doc

add_flashlight

Setting: add_flashlight

Doc Status: No Doc

add_service_title

Setting: add_service_title

Doc Status: No Doc

add_to_app_badge

Setting: add_to_app_badge

Doc Status: No Doc

address

Setting: address

Doc Status: No Doc

ajaxurl

Setting: ajaxurl

Doc Status: No Doc

alert_for_new_version

Setting: alert_for_new_version

This triggers the app to check for an updated version.  If a new version exists in the app store, then an alert is displayed asking the user to update. This feature can be updated on the general servings tab of the app settings page.

Doc Status: Public

align

Setting: align

Doc Status: No Doc

align_bottom

Setting: align_bottom

Doc Status: No Doc

all_square

Setting: all_square

Doc Status: No Doc

always_hide_chat

Setting: always_hide_chat

Doc Status: No Doc

always_show_chat

Setting: always_show_chat

Doc Status: No Doc

always_show_notifications

Setting: always_show_notifications

Doc Status: No Doc

api

Setting: api

Doc Status: No Doc

api_2

Setting: api_2

Doc Status: No Doc

app_permissions_use_onboarding

Setting: app_permissions_use_onboarding

Doc Status: No Doc

aspect

Setting: aspect

Doc Status: No Doc

avatar

Setting: avatar

Doc Status: No Doc

background

Setting: background

Doc Status: No Doc

background_clear

Setting: background_clear

Doc Status: No Doc

background_color_red

Setting: background_color_red

Doc Status: No Doc

background_image

Setting: background_image

Doc Status: No Doc

background_red

Setting: background_red

Doc Status: No Doc

background_reload_after_loading

Setting: background_reload_after_loading

Doc Status: No Doc

badge

Setting: badge

Doc Status: No Doc

badges

Setting: badges

Doc Status: No Doc

bar_shade

Setting: bar_shade

Doc Status: No Doc

ble_min_range

Setting: ble_min_range

Doc Status: No Doc

ble_range

Setting: ble_range

Doc Status: No Doc

block_landscape

Setting: block_landscape

Doc Status: No Doc

block_portrait

Setting: block_portrait

Doc Status: No Doc

blue

Setting: blue

Doc Status: No Doc

bold

Setting: bold

Doc Status: No Doc

bottom_image

Setting: bottom_image

Doc Status: No Doc

bottom_image_width

Setting: bottom_image_width

Doc Status: No Doc

bottom_margin

Setting: bottom_margin

Doc Status: No Doc

bottom_nav_haader_top_border_color

Setting: bottom_nav_haader_top_border_color

Doc Status: No Doc

bottom_nav_haader_top_border_color_red

Setting: bottom_nav_haader_top_border_color_red

Doc Status: No Doc

bottom_nav_header_top_border_color_red

Setting: bottom_nav_header_top_border_color_red

This is used in Orland perks to highlight the bottom tabbar. Need to get OP working then we can handle this.
Also need to fix the setting name due to the typo

Doc Status: Needs Testing

button_at_top

Setting: button_at_top

Doc Status: No Doc

button_category

Setting: button_category

Doc Status: No Doc

button_id

Setting: button_id

Doc Status: No Doc

button_name

Setting: button_name

Doc Status: No Doc

button_title

Setting: button_title

Doc Status: No Doc

button_title_2

Setting: button_title_2

Doc Status: No Doc

button_title_3

Setting: button_title_3

Doc Status: No Doc

button_type

Setting: button_type

Doc Status: No Doc

buttons

Setting: buttons

Doc Status: No Doc

calendar_layout

Setting: calendar_layout

Doc Status: No Doc

can_add_to_cart

Setting: can_add_to_cart

Doc Status: No Doc

carousel

Setting: carousel

Doc Status: No Doc

cart_badge_color

Setting:

Setting: cart_badge_color

  • Category: App UI Setting
  • Purpose: This setting controls the color of the cart badge in the top navigation header on iOS and Android phones.
  • Usage Example: The cart badge can be set to a distinct color such as ‘red’ or ‘green’ to attract user attention or match the app’s branding.
  • Effect: Changing this setting modifies the appearance of the cart badge, enhancing visibility and ensuring it aligns with the app’s visual design, which can improve user engagement with the shopping cart feature.
Doc Status: No Doc

cat

Setting: cat

Doc Status: No Doc

cat_name

Setting: cat_name

Doc Status: No Doc

category

Setting: category

Doc Status: No Doc

center_button

Setting: center_button

Doc Status: No Doc

chatting_with_name

Setting: chatting_with_name

Doc Status: No Doc

check_service_message

Setting: check_service_message

Doc Status: No Doc

check_service_placeholder

Setting: check_service_placeholder

Doc Status: No Doc

check_service_result

Setting: check_service_result

Doc Status: No Doc

check_service_selected_zip

Setting: check_service_selected_zip

Doc Status: No Doc

checkbox_color

Setting: checkbox_color

Doc Status: No Doc

checked_into_store_id

Setting: checked_into_store_id

Doc Status: No Doc

checkin_message

Setting: checkin_message

Doc Status: No Doc

checkout_has_incremental_order

Setting: checkout_has_incremental_order

Doc Status: No Doc

checkout_has_pickup_delivery_options_by_categories

Setting: checkout_has_pickup_delivery_options_by_categories

Doc Status: No Doc

clear_data_on_geofilter_change

Setting: clear_data_on_geofilter_change

Doc Status: No Doc

clipboard

Setting: clipboard

Doc Status: No Doc

close_button

Setting: close_button

Doc Status: No Doc

col_layout_type

Setting: col_layout_type

Doc Status: No Doc

collapsible

Setting: collapsible

Doc Status: No Doc

collection_type

Setting: collection_type

Doc Status: No Doc

color

Setting: color

Doc Status: No Doc

columns

Setting: columns

Doc Status: No Doc

complete_button_action

Setting: complete_button_action

Doc Status: No Doc

content

Setting: content

Doc Status: No Doc

content_height

Setting: content_height

Doc Status: No Doc

content_type

Setting: content_type

Doc Status: No Doc

cursor

Setting: cursor

Doc Status: No Doc

custom_button_is_rounded

Setting: custom_button_is_rounded

Doc Status: No Doc

data

Setting: data

Doc Status: No Doc

data_has_search_index

Setting: data_has_search_index

Doc Status: No Doc

data_type

Setting: data_type

Doc Status: No Doc

days

Setting: days

Doc Status: No Doc

demo

Setting: demo

This setting is deprecated. Demo can be removed form al app API calls.

Doc Status: Remove

dialog_signin_or_signup_message

Setting: dialog_signin_or_signup_message

Doc Status: No Doc

dialog_signin_or_signup_message_button_cancel

Setting: dialog_signin_or_signup_message_button_cancel

Doc Status: No Doc

dialog_signin_or_signup_message_button_ok

Setting: dialog_signin_or_signup_message_button_ok

Doc Status: No Doc

dialog_signin_or_signup_title

Setting: dialog_signin_or_signup_title

Doc Status: No Doc

directions_use_auto

Setting: directions_use_auto

Doc Status: No Doc

display_as_label

Setting: display_as_label

Doc Status: No Doc

display_using_chips

Setting: display_using_chips

Doc Status: No Doc

dont_adjust_font_size

Setting: dont_adjust_font_size

Doc Status: No Doc

empty_aspect

Setting: empty_aspect

Doc Status: No Doc

empty_image

Setting: empty_image

Doc Status: No Doc

Enable GPS for User Location

Setting: use_gps

This enables the GPS features and gets the user’s latitude and longitude. This is used to determine the user’s distance from various locations like listings. After turning this feature on, you must republish your app if you have already published it to Apple or Google.

This setting is available on the General Settings tab on the App Settings page.

Doc Status: Public

enabled_days

Setting: enabled_days

Doc Status: No Doc

extension

Setting: extension

Doc Status: No Doc

fac_premium_image

Setting: fac_premium_image

Doc Status: No Doc

fac_reciprocate_image

Setting: fac_reciprocate_image

Doc Status: No Doc

faceted_search_inline

Setting: faceted_search_inline

Doc Status: No Doc

faceted_search_label_color

Setting: faceted_search_label_color

Doc Status: No Doc

featured_listings_alt_title

Setting: featured_listings_alt_title

Doc Status: No Doc

featured_listings_title

Setting: featured_listings_title

Doc Status: No Doc

feaured_listing_title

Setting: feaured_listing_title

Doc Status: No Doc

field

Setting: field

Doc Status: No Doc

field_id

Setting: field_id

Doc Status: No Doc

floating_button

Setting: floating_button

Doc Status: No Doc

font_size

Setting: font_size

Doc Status: No Doc

for_sale

Setting: for_sale

Doc Status: No Doc

for_trade

Setting: for_trade

Doc Status: No Doc

force_reload_on_open

Setting: force_reload_on_open

Doc Status: No Doc

form

Setting: form

Doc Status: No Doc

form_id

Setting: form_id

Doc Status: No Doc

frame_id

Setting: frame_id

Doc Status: No Doc

geofilter_background_color

Setting: geofilter_background_color

Doc Status: No Doc

geofilter_border_color

Setting: geofilter_border_color

Doc Status: No Doc

geofilter_button_shape_rounded

Setting: geofilter_button_shape_rounded

Doc Status: No Doc

geofilter_default_name

Setting: geofilter_default_name

Doc Status: No Doc

geofilter_icon

Setting: geofilter_icon

Doc Status: No Doc

geofilter_icon_on_right

Setting: geofilter_icon_on_right

Doc Status: No Doc

geofilter_marker_button_color

Setting: geofilter_marker_button_color

Doc Status: No Doc

geofilter_radius

Setting: geofilter_radius

Doc Status: No Doc

geofilter_required_location

Setting: geofilter_required_location

Doc Status: No Doc

geofilter_required_location_lat

Setting: geofilter_required_location_lat

Doc Status: No Doc

geofilter_required_location_lon

Setting: geofilter_required_location_lon

Doc Status: No Doc

geofilter_required_placeholder

Setting: geofilter_required_placeholder

Doc Status: No Doc

geofilter_text_color

Setting: geofilter_text_color

Doc Status: No Doc

geofilters_are_persistent

Setting: geofilters_are_persistent

Doc Status: No Doc

geofilters_background_clear

Setting: geofilters_background_clear

Doc Status: No Doc

geofilters_current_city

Setting: geofilters_current_city

Doc Status: No Doc

geofilters_show_as_icon

Setting: geofilters_show_as_icon

Doc Status: No Doc

geofilters_show_neighborhoods

Setting: geofilters_show_neighborhoods

Doc Status: No Doc

geofilters_use_select_event_icon

Setting: geofilters_use_select_event_icon

Doc Status: No Doc

gf_min_radius

Setting: gf_min_radius

Doc Status: No Doc

global_font

Setting: global_font

This is the font for the entire app. If you want a font that is not currently available, drop us a support ticket and we can add it.

This setting is on the General Setting tab on teh App Setting page.

Doc Status: Public

gotocheckout

Setting: gotocheckout

Doc Status: No Doc

green

Setting: green

Doc Status: No Doc

group_id

Setting: group_id

Doc Status: No Doc

groups

Setting: groups

Doc Status: No Doc

guid

Setting: guid

Doc Status: No Doc

has_chat

Setting: has_chat

Doc Status: No Doc

has_faceted_search

Setting: has_faceted_search

Doc Status: No Doc

has_favs_section

Setting: has_favs_section

Doc Status: No Doc

has_HomeForTabbar_hidden

Setting: has_HomeForTabbar_hidden

Doc Status: No Doc

has_initial_form_to_display

Setting: has_initial_form_to_display

Doc Status: No Doc

has_left_menu

Setting: has_left_menu

Doc Status: No Doc

has_points_manager

Setting: has_points_manager

Doc Status: No Doc

has_qr_code_scanner

Setting: has_qr_code_scanner

Doc Status: No Doc

has_sharing_bar

Setting: has_sharing_bar

Doc Status: No Doc

hasInappPurchaseTrial

Setting: hasInappPurchaseTrial

Doc Status: No Doc

hasOrders

Setting: hasOrders

Doc Status: No Doc

hasPageView

Setting: hasPageView

Doc Status: No Doc

headerLabel

Setting: headerLabel

Doc Status: No Doc

height

Setting: height

Doc Status: No Doc

Hide the titles on the bottom tab bar to show icons only

Setting: hide_titles_for_tabs_for_homepage

If you want to hide the titles on the bottom tab bar and only show icons then set this setting to yes.

This setting is available on the General Setting tab on the App Setting page.

Doc Status: Public

hide_cart_button_always

Setting: hide_cart_button_always

Doc Status: No Doc

hide_days

Setting: hide_days

Doc Status: No Doc

hide_featured_listings_title

Setting: hide_featured_listings_title

Doc Status: No Doc

hide_geofilters

Setting: hide_geofilters

Doc Status: No Doc

hide_pins

Setting: hide_pins

Doc Status: No Doc

hide_tabbar_on_homescreen

Setting: hide_tabbar_on_homescreen

Doc Status: No Doc

home_background_color

Setting: home_background_color

Doc Status: No Doc

home_cat_tabbar_is_sticky

Setting: home_cat_tabbar_is_sticky

Doc Status: No Doc

home_cat_tabbar_remove_sticky_on_restart_sticky

Setting: home_cat_tabbar_remove_sticky_on_restart_sticky

Doc Status: No Doc

home_chip_width

Setting: home_chip_width

Doc Status: No Doc

home_chip_width_same

Setting: home_chip_width_same

Doc Status: No Doc

home_chips_background_is_header_color

Setting: home_chips_background_is_header_color

Doc Status: No Doc

home_clear_all

Setting: home_clear_all

Doc Status: No Doc

home_collection_frame_id

Setting: home_collection_frame_id

Doc Status: No Doc

home_collection_layout_id

Setting: home_collection_layout_id

Doc Status: No Doc

home_collection_layout_type

Setting: home_collection_layout_type

Doc Status: No Doc

home_filter_bar_text_color

Setting: home_filter_bar_text_color

Doc Status: No Doc

home_filter_bar_unselected_text_color

Setting: home_filter_bar_unselected_text_color

Doc Status: No Doc

home_horz_scroller_text

Setting: home_horz_scroller_text

Doc Status: No Doc

home_horz_scroller_text_text

Setting: home_horz_scroller_text_text

Doc Status: No Doc

home_is_storefront

Setting: home_is_storefront

Doc Status: No Doc

home_left_menu_bottom_image

Setting: home_left_menu_bottom_image

Doc Status: No Doc

home_left_menu_bottom_image_aspect

Setting: home_left_menu_bottom_image_aspect

Doc Status: No Doc

home_left_menu_bottom_label

Setting: home_left_menu_bottom_label

Doc Status: No Doc

home_left_menu_top_image

Setting: home_left_menu_top_image

Doc Status: No Doc

home_left_menu_top_image_aspect

Setting: home_left_menu_top_image_aspect

Doc Status: No Doc

home_map_lat

Setting: home_map_lat

Doc Status: No Doc

home_map_lon

Setting: home_map_lon

Doc Status: No Doc

home_middle_image_url

Setting: home_middle_image_url

Doc Status: No Doc

home_nav_add_listing_form

Setting: home_nav_add_listing_form

Doc Status: No Doc

home_nav_show_alerts

Setting: home_nav_show_alerts

Doc Status: No Doc

home_nav_user_profile_form

Setting: home_nav_user_profile_form

Doc Status: No Doc

home_right_customer_nav_button

Setting: home_right_customer_nav_button

Doc Status: No Doc

home_right_customer_nav_button_action

Setting: home_right_customer_nav_button_action

Doc Status: No Doc

home_right_customer_nav_button_exclusive_filter

Setting: home_right_customer_nav_button_exclusive_filter

Doc Status: No Doc

home_right_customer_nav_button_location

Setting: home_right_customer_nav_button_location

Doc Status: No Doc

home_right_customer_nav_button_screen_title

Setting: home_right_customer_nav_button_screen_title

Doc Status: No Doc

home_right_customer_nav_button_show

Setting: home_right_customer_nav_button_show

Doc Status: No Doc

home_right_customer_nav_button_source

Setting: home_right_customer_nav_button_source

Doc Status: No Doc

home_screen_bar_shade_color

Setting: home_screen_bar_shade_color

Doc Status: No Doc

home_screen_collection_view_columns

Setting: home_screen_collection_view_columns

Doc Status: No Doc

home_screen_embed_search_at_top

Setting: home_screen_embed_search_at_top

Doc Status: No Doc

home_screen_event_view_all

Setting: home_screen_event_view_all

Doc Status: Remove

home_screen_featured_view_all

Setting: home_screen_featured_view_all

Doc Status: No Doc

home_screen_left_menu_show_user_name

Setting: home_screen_left_menu_show_user_name

Doc Status: No Doc

home_screen_local_category_bar

Setting: home_screen_local_category_bar

Doc Status: No Doc

home_screen_no_logo_animation

Setting: home_screen_no_logo_animation

Doc Status: No Doc

home_screen_review_count

Setting: home_screen_review_count

Doc Status: No Doc

home_screen_table_no_taps

Setting: home_screen_table_no_taps

Doc Status: No Doc

home_screen_table_tap_add_to_cart

Setting: home_screen_table_tap_add_to_cart

Doc Status: No Doc

home_search_api_search

Setting: home_search_api_search

Doc Status: No Doc

home_search_border_clear

Setting: home_search_border_clear

Doc Status: No Doc

home_search_has_barcode

Setting: home_search_has_barcode

Doc Status: No Doc

home_search_placeholder

Setting: home_search_placeholder

Doc Status: No Doc

home_search_simple_search

Setting: home_search_simple_search

Doc Status: No Doc

home_section_header_color

Setting: home_section_header_color

Doc Status: No Doc

home_section_header_text_color

Setting: home_section_header_text_color

Doc Status: No Doc

home_set_selected_tag_using_category

Setting: home_set_selected_tag_using_category

Doc Status: No Doc

home_show_checkin

Setting: home_show_checkin

Doc Status: No Doc

home_show_custom_option_button

Setting: home_show_custom_option_button

Doc Status: No Doc

home_show_custom_option_button_number

Setting: home_show_custom_option_button_number

Doc Status: No Doc

home_show_custom_option_button_number_left

Setting: home_show_custom_option_button_number_left

Doc Status: No Doc

home_show_custom_option_button_only_with_cat

Setting: home_show_custom_option_button_only_with_cat

Doc Status: No Doc

home_show_custom_option_tag

Setting: home_show_custom_option_tag

Doc Status: No Doc

home_tagged_nav_background

Setting: home_tagged_nav_background

Doc Status: No Doc

home_tagged_nav_background_red

Setting: home_tagged_nav_background_red

Doc Status: No Doc

home_tagged_nav_number_of_buttons

Setting: home_tagged_nav_number_of_buttons

Doc Status: No Doc

home_tagged_nav_number_of_rows

Setting: home_tagged_nav_number_of_rows

Doc Status: No Doc

home_vc

Setting: home_vc

Doc Status: No Doc

home_vc_title

Setting: home_vc_title

Doc Status: No Doc

home_vc_title_no_transform

Setting: home_vc_title_no_transform

Doc Status: No Doc

home_vendor_list_main_table

Setting: home_vendor_list_main_table

Doc Status: No Doc

home_vendor_list_sub_table

Setting: home_vendor_list_sub_table

Doc Status: No Doc

home_zoom_level

Setting: home_zoom_level

Doc Status: No Doc

homescreen_allow_multi_category_selection

Setting: homescreen_allow_multi_category_selection

Doc Status: No Doc

homescreen_cart_shows_my_cart

Setting: homescreen_cart_shows_my_cart

Doc Status: No Doc

homescreen_diag_on

Setting: homescreen_diag_on

Doc Status: No Doc

homescreen_filter_min_sections_for_all

Setting: homescreen_filter_min_sections_for_all

Doc Status: No Doc

homescreen_h_scrollers_cell_height

Setting: homescreen_h_scrollers_cell_height

Doc Status: No Doc

homescreen_h_scrollers_center_title

Setting: homescreen_h_scrollers_center_title

Doc Status: No Doc

homescreen_h_scrollers_font

Setting: homescreen_h_scrollers_font

Doc Status: No Doc

homescreen_h_scrollers_image_framed

Setting: homescreen_h_scrollers_image_framed

Doc Status: No Doc

homescreen_h_scrollers_is_framed

Setting: homescreen_h_scrollers_is_framed

Doc Status: No Doc

homescreen_h_scrollers_open_listview

Setting: homescreen_h_scrollers_open_listview

Doc Status: No Doc

homescreen_h_scrollers_open_points

Setting: homescreen_h_scrollers_open_points

Doc Status: No Doc

homescreen_h_scrollers_variable_width

Setting: homescreen_h_scrollers_variable_width

Doc Status: No Doc

homescreen_hide_all_filter_bar

Setting: homescreen_hide_all_filter_bar

Doc Status: No Doc

homescreen_no_limit_on_refresh_timer

Setting: homescreen_no_limit_on_refresh_timer

Doc Status: No Doc

homescreen_search_placeholder_use_cat

Setting: homescreen_search_placeholder_use_cat

Doc Status: No Doc

homescreen_stack

Setting: homescreen_stack

Doc Status: No Doc

homescreen_stack_animiations_on

Setting: homescreen_stack_animiations_on

Doc Status: No Doc

homescreen_stack_scrolls_on_nav_header_tap

Setting: homescreen_stack_scrolls_on_nav_header_tap

Doc Status: No Doc

homescreen_stack_starts_at_top

Setting: homescreen_stack_starts_at_top

This overrides the nav header to allow the content to extend to the top of the screen. Can only be used if no left menu and transparent nav header is set to yes.

This setting can be set for each supported role in the App Settings screen.

Doc Status: Public

homescreen_tag_cloud_behavior_toggle

Setting: homescreen_tag_cloud_behavior_toggle

Doc Status: No Doc

homescreen_tag_cloud_first_tag_selected

Setting: homescreen_tag_cloud_first_tag_selected

Doc Status: No Doc

homescreen_tag_cloud_label

Setting: homescreen_tag_cloud_label

Doc Status: No Doc

homescreen_tag_cloud_selected

Setting: homescreen_tag_cloud_selected

Doc Status: No Doc

homescreen_tag_cloud_selected_text

Setting: homescreen_tag_cloud_selected_text

Doc Status: No Doc

homescreen_tag_cloud_text_selected

Setting: homescreen_tag_cloud_text_selected

Doc Status: No Doc

homescreen_tag_cloud_text_unselected

Setting: homescreen_tag_cloud_text_unselected

Doc Status: No Doc

homescreen_tag_cloud_unselected

Setting: homescreen_tag_cloud_unselected

Doc Status: No Doc

homescreen_tag_cloud_unselected_text

Setting: homescreen_tag_cloud_unselected_text

Doc Status: No Doc

homescreen_use_main_data_for_hsv_view_1

Setting: homescreen_use_main_data_for_hsv_view_1

Doc Status: No Doc

hs_display_using_chips_single

Setting: hs_display_using_chips_single

Doc Status: No Doc

hs_make_chips_oval

Setting: hs_make_chips_oval

Doc Status: No Doc

hs_make_tag_chips_oval

Setting: hs_make_tag_chips_oval

Doc Status: No Doc

hs_stack_user_profile

Setting: hs_stack_user_profile

Doc Status: No Doc

id

Setting: id

Doc Status: No Doc

image

Setting: image

Doc Status: No Doc

image_buffer

Setting: image_buffer

Doc Status: No Doc

image_id

Setting: image_id

Doc Status: No Doc

image_info

Setting: image_info

Doc Status: No Doc

imageurl

Setting: imageurl

Doc Status: No Doc

img_aspect

Setting: img_aspect

Doc Status: No Doc

img_height

Setting: img_height

Doc Status: No Doc

img_width

Setting: img_width

Doc Status: No Doc

inapp_has_iap

Setting: inapp_has_iap

Doc Status: No Doc

inapp_is_required

Setting: inapp_is_required

Doc Status: No Doc

index

Setting: index

Doc Status: No Doc

initial_form_to_display

Setting: initial_form_to_display

Doc Status: No Doc

initial_home_section

Setting: initial_home_section

Doc Status: No Doc

initial_load_clear_loading_screen

Setting: initial_load_clear_loading_screen

Doc Status: No Doc

instructions_view

Setting: instructions_view

Doc Status: No Doc

instructions_view_can_toggle

Setting: instructions_view_can_toggle

Doc Status: No Doc

is_checkin_type_app

Setting: is_checkin_type_app

Doc Status: No Doc

is_for_geofilter

Setting: is_for_geofilter

Doc Status: No Doc

is_logged_in

Setting: is_logged_in

Doc Status: No Doc

item_title

Setting: item_title

Doc Status: No Doc

keep_awake_while_open

Setting: keep_awake_while_open

Doc Status: No Doc

keep_social_in_app

Setting: keep_social_in_app

Doc Status: No Doc

keyboard

Setting: keyboard

Doc Status: No Doc

label

Setting: label

Doc Status: No Doc

languageOptions

Setting: languageOptions

Doc Status: No Doc

large_only

Setting: large_only

Doc Status: No Doc

lat

Setting: lat

Doc Status: No Doc

layout_height

Setting: layout_height

Doc Status: No Doc

layout_id

Setting: layout_id

Doc Status: No Doc

layout_type

Setting: layout_type

Doc Status: No Doc

layout_var_height

Setting: layout_var_height

Doc Status: No Doc

left_margin

Setting: left_margin

Doc Status: No Doc

left_menu_allow_lowercase

Setting: left_menu_allow_lowercase

Doc Status: No Doc

left_menu_background_color

Setting: left_menu_background_color

Doc Status: No Doc

left_menu_button_height

Setting: left_menu_button_height

Doc Status: No Doc

left_menu_full_width

Setting: left_menu_full_width

Doc Status: No Doc

left_menu_header_color

Setting: left_menu_header_color

Doc Status: No Doc

left_menu_header_color_red

Setting: left_menu_header_color_red

Doc Status: No Doc

left_menu_icon_color

Setting: left_menu_icon_color

Doc Status: No Doc

left_menu_icons

Setting: left_menu_icons

Doc Status: No Doc

left_menu_image_width

Setting: left_menu_image_width

Doc Status: No Doc

left_menu_profile_text_color

Setting: left_menu_profile_text_color

Doc Status: No Doc

left_menu_sep_line

Setting: left_menu_sep_line

Doc Status: No Doc

left_menu_sep_line_red

Setting: left_menu_sep_line_red

Doc Status: No Doc

left_menu_show_profile_summary

Setting: left_menu_show_profile_summary

Doc Status: No Doc

left_menu_text_color

Setting: left_menu_text_color

Doc Status: No Doc

left_menu_width

Setting: left_menu_width

Doc Status: No Doc

listing_delete_record_button_cancel

Setting: listing_delete_record_button_cancel

Doc Status: No Doc

listing_delete_record_button_ok

Setting: listing_delete_record_button_ok

Doc Status: No Doc

listing_hide_table_row_lines

Setting: listing_hide_table_row_lines

Doc Status: No Doc

listing_layout_height

Setting: listing_layout_height

Doc Status: No Doc

listing_layout_id

Setting: listing_layout_id

Doc Status: No Doc

listing_sharing_message

Setting: listing_sharing_message

Doc Status: No Doc

listing_sharing_use_site_url

Setting: listing_sharing_use_site_url

Doc Status: No Doc

listing_show_homescreen_reviews

Setting: listing_show_homescreen_reviews

Doc Status: No Doc

login_button_title

Setting: login_button_title

Doc Status: No Doc

logo_scaling

Setting: logo_scaling

Doc Status: No Doc

main_checkin_header_title

Setting: main_checkin_header_title

Doc Status: No Doc

main_events_header_title

Setting: main_events_header_title

Doc Status: No Doc

main_featured_header_title

Setting: main_featured_header_title

Doc Status: No Doc

main_key

Setting: main_key

Doc Status: No Doc

main_review_header_title

Setting: main_review_header_title

Doc Status: No Doc

main_scan_button_title

Setting: main_scan_button_title

Doc Status: No Doc

main_title

Setting: main_title

Doc Status: No Doc

main_top_label

Setting: main_top_label

Doc Status: No Doc

map_data

Setting: map_data

Doc Status: No Doc

map_pin_url

Setting: map_pin_url

Doc Status: No Doc

match_enabled

Setting: match_enabled

Doc Status: No Doc

match_image

Setting: match_image

Doc Status: No Doc

match_images_inline

Setting: match_images_inline

Doc Status: No Doc

match_skip_snackbar_message

Setting: match_skip_snackbar_message

Doc Status: No Doc

match_snackbar_message

Setting: match_snackbar_message

Doc Status: No Doc

message

Setting: message

Doc Status: No Doc

min_per_mile

Setting: min_per_mile

Doc Status: No Doc

my_bookmarked

Setting: my_bookmarked

Doc Status: No Doc

my_bookmarked_title

Setting: my_bookmarked_title

Doc Status: No Doc

my_listings

Setting: my_listings

Doc Status: No Doc

my_listings_button

Setting: my_listings_button

Doc Status: No Doc

my_listings_tag

Setting: my_listings_tag

Doc Status: No Doc

my_listings_title

Setting: my_listings_title

Doc Status: No Doc

my_reviews

Setting: my_reviews

Doc Status: No Doc

my_reviews_title

Setting: my_reviews_title

Doc Status: No Doc

my_views

Setting: my_views

Doc Status: No Doc

my_views_title

Setting: my_views_title

Doc Status: No Doc

name

Setting: name

Doc Status: No Doc

nearby_prefix

Setting: nearby_prefix

Doc Status: No Doc

No records image for list screens

Setting: no_content_image

Select an image to display on the list view for when there are no records to be displayed.

This setting is on the individual button screens.

Doc Status: Public

no_content_image_aspect

Setting: no_content_image_aspect

Doc Status: No Doc

no_gps_alert

Setting: no_gps_alert

Doc Status: No Doc

no_open_menu

Setting: no_open_menu

Doc Status: No Doc

no_radius

Setting: no_radius

Doc Status: No Doc

no_records

Setting: no_records

Doc Status: No Doc

no_swipe_for_left_menu

Setting: no_swipe_for_left_menu

Doc Status: No Doc

no_tap

Setting: no_tap

Doc Status: No Doc

no_title

Setting: no_title

Doc Status: No Doc

noLeftMenuSwipe

Setting: noLeftMenuSwipe

Doc Status: No Doc

num_buttons

Setting: num_buttons

Doc Status: No Doc

num_lines

Setting: num_lines

Doc Status: No Doc

offline_use_allowed

Setting: offline_use_allowed

Doc Status: No Doc

onboarding_cursor

Setting: onboarding_cursor

Doc Status: No Doc

onboarding_cursor_override

Setting: onboarding_cursor_override

Doc Status: No Doc

open_button_title

Setting: open_button_title

Doc Status: No Doc

open_content

Setting: open_content

Doc Status: No Doc

open_form

Setting: open_form

Doc Status: No Doc

open_home

Setting: open_home

Doc Status: No Doc

open_left

Setting: open_left

Doc Status: No Doc

open_url

Setting: open_url

Doc Status: No Doc

options

Setting: options

Doc Status: No Doc

origin_lat

Setting: origin_lat

Doc Status: No Doc

origin_lon

Setting: origin_lon

Doc Status: No Doc

oval_search

Setting: oval_search

Doc Status: No Doc

page_view_source

Setting: page_view_source

Doc Status: No Doc

panels

Setting: panels

Doc Status: No Doc

Phone Status Bar Color

Setting: status_bar_color

Setting: Status Bar Color

  • Category: App UI Setting
  • Purpose: This setting controls the color of the status bar that displays the time and battery level on the top of the phone.
  • Usage Example: The status bar can be set to either ‘black’ or ‘white’ depending on the app’s background design to enhance visibility.
  • Effect: Changing this setting adjusts the color of the status bar, ensuring it complements the app’s overall aesthetic and improves user experience by making the information displayed (time, battery level) more readable against the chosen app background color.
Doc Status: Public

photo_array

Setting: photo_array

Doc Status: No Doc

pin_to_top

Setting: pin_to_top

Doc Status: No Doc

pinToBottom

Setting: pinToBottom

Doc Status: No Doc

placeholder

Setting: placeholder

Doc Status: No Doc

placeholder_2

Setting: placeholder_2

Doc Status: No Doc

pn_status

Setting: pn_status

Doc Status: No Doc

post_form_onboarding

Setting: post_form_onboarding

Doc Status: No Doc

pre_login_onboarding_cursor

Setting: pre_login_onboarding_cursor

Doc Status: No Doc

prefix

Setting: prefix

Doc Status: No Doc

price

Setting: price

Doc Status: No Doc

profile_block_count

Setting: profile_block_count

Doc Status: No Doc

profile_center_titles

Setting: profile_center_titles

Doc Status: No Doc

profile_hide_add_listing

Setting: profile_hide_add_listing

Doc Status: No Doc

profile_hide_all_blocks

Setting: profile_hide_all_blocks

Doc Status: No Doc

profile_hide_bottom_blocks

Setting: profile_hide_bottom_blocks

Doc Status: No Doc

profile_hide_edit_listing

Setting: profile_hide_edit_listing

Doc Status: No Doc

profile_main_font_size

Setting: profile_main_font_size

Doc Status: No Doc

profile_subtitle

Setting: profile_subtitle

Doc Status: No Doc

profile_subtitle_font_size

Setting: profile_subtitle_font_size

Doc Status: No Doc

progress

Setting: progress

Doc Status: No Doc

progress_label_1

Setting: progress_label_1

Doc Status: No Doc

progress_progress_red

Setting: progress_progress_red

Doc Status: No Doc

progress_track_red

Setting: progress_track_red

Doc Status: No Doc

punch_in_button_title

Setting: punch_in_button_title

Doc Status: No Doc

punch_in_interval

Setting: punch_in_interval

Doc Status: No Doc

punch_in_is_on_duty

Setting: punch_in_is_on_duty

Doc Status: No Doc

punch_in_message

Setting: punch_in_message

Doc Status: No Doc

punch_in_opt_in

Setting: punch_in_opt_in

Doc Status: No Doc

punch_in_tracker

Setting: punch_in_tracker

Doc Status: No Doc

punch_in_tracking_message

Setting: punch_in_tracking_message

Doc Status: No Doc

punch_in_tracking_title

Setting: punch_in_tracking_title

Doc Status: No Doc

recalculate_off_route_distance

Setting: recalculate_off_route_distance

Doc Status: No Doc

recipient

Setting: recipient

Doc Status: No Doc

recipient_id

Setting: recipient_id

Doc Status: No Doc

record_response

Setting: record_response

Doc Status: No Doc

red

Setting: red

Doc Status: No Doc

refresh_homescreen_on_pn

Setting: refresh_homescreen_on_pn

Doc Status: No Doc

refresh_timer_on_home_screen

Setting: refresh_timer_on_home_screen

Doc Status: No Doc

reject_image

Setting: reject_image

Doc Status: No Doc

reload_homescreen_on_push_notification

Setting: reload_homescreen_on_push_notification

Doc Status: No Doc

reload_homescreen_on_push_notification_with_alert

Setting: reload_homescreen_on_push_notification_with_alert

Doc Status: No Doc

Require GPS

Setting: require_gps

If your application for a user role requires GPS, like driver tracking, then set this value to yes. After turning this feature on, you must republish your app if you have already published it to Apple or Google.

This setting is available on the General Settings tab on the App Settings page.

Doc Status: Public

require_approval

Setting: require_approval

Doc Status: No Doc

require_iap

Setting: require_iap

Doc Status: No Doc

require_login

Setting: require_login

Doc Status: No Doc

review_layout_id

Setting: review_layout_id

Doc Status: No Doc

ripple

Setting: ripple

Doc Status: No Doc

rounded_buttons

Setting: rounded_buttons

Doc Status: No Doc

rounded_corners

Setting: rounded_corners

Doc Status: No Doc

rows

Setting: rows

Doc Status: No Doc

scanned_items_view

Setting: scanned_items_view

Doc Status: No Doc

scanner_hidden

Setting: scanner_hidden

Doc Status: No Doc

screen_help

Setting: screen_help

Doc Status: No Doc

search_has_border

Setting: search_has_border

Doc Status: No Doc

search_load_new_screen

Setting: search_load_new_screen

Doc Status: No Doc

search_terms

Setting: search_terms

Doc Status: No Doc

secondVideo

Setting: secondVideo

Doc Status: No Doc

section_info_imageurl

Setting: section_info_imageurl

Doc Status: No Doc

selectedLanguage

Setting: selectedLanguage

Doc Status: No Doc

selectedLanguageImage

Setting: selectedLanguageImage

Doc Status: No Doc

seller_id

Setting: seller_id

Doc Status: No Doc

seller_name

Setting: seller_name

Doc Status: No Doc

send_gps_pings

Setting: send_gps_pings

Doc Status: No Doc

send_gps_pings_frequency

Setting: send_gps_pings_frequency

Doc Status: No Doc

send_gps_pings_on_activities

Setting: send_gps_pings_on_activities

Doc Status: No Doc

Set background color of all top Navigation Headers

Setting: header

This sets the background color for all the top nav headers throughout the app.

This can be set on the General Setting tab of the App Settings page.

Doc Status: Public

Set Nav Header Text Color

Setting: nav_bar_text_color

This sets the text color for the nav headers throughout the app.

This setting is available on the General Settings tab on the App Setting page.

Doc Status: Public

Set the bottom tab bar text and icon color

Setting: tabbar_icon_color

Set the color you want for the icon and text color of the bottom tab bar.

This setting is available on teh General Setting tab of the App Settings screen.

Doc Status: Public

Set the color for the bottom tab bar

Setting: tabbar_color

This sets the background color for the bottom tabbar on all screens.

This can be set on the General Settings tab on the App Setting page.

Doc Status: Public

Set the nav header to be transparent

Setting: use_transparent_header

If you want to make the nav header transparent, set this to yes. Home screen elements will be visible as they scroll all the way to the top.

This setting is available on the General Settings tab of the App Setting page.

Doc Status: Public

Set the unselected icon color for the bottom tab bar

Setting: tabbar_unselected_icon_color

This sets the color for the icon and text for the bottom tab bar on all screens when the item is not selected.

This setting is available on the General Setting tab of the App Setting page.

Doc Status: Public

set_match_locally

Setting: set_match_locally

Doc Status: No Doc

shape

Setting: shape

Doc Status: No Doc

share_link

Setting: share_link

Doc Status: No Doc

show_app_logo

Setting: show_app_logo

Doc Status: No Doc

show_cards_on_map

Setting: show_cards_on_map

Doc Status: No Doc

show_cart_button_always

Setting: show_cart_button_always

Doc Status: No Doc

show_detailed_reviews

Setting: show_detailed_reviews

Doc Status: No Doc

show_last_result

Setting: show_last_result

Doc Status: No Doc

show_left_menu_back_button

Setting: show_left_menu_back_button

Doc Status: No Doc

show_location_stats_on_home

Setting: show_location_stats_on_home

Doc Status: No Doc

show_recent

Setting: show_recent

Doc Status: No Doc

show_route

Setting: show_route

Doc Status: No Doc

show_scan_button_always

Setting: show_scan_button_always

Doc Status: No Doc

show_time

Setting: show_time

Doc Status: No Doc

show_time_groups

Setting: show_time_groups

Doc Status: No Doc

single_button

Setting: single_button

Doc Status: No Doc

snackbar_background_color

Setting: snackbar_background_color

Doc Status: No Doc

snackbar_text_color

Setting: snackbar_text_color

Doc Status: No Doc

sort_by_recent

Setting: sort_by_recent

Doc Status: No Doc

splash_screen_1125_436

Setting: splash_screen_1125_436

Doc Status: No Doc

splash_screen_640_1136

Setting: splash_screen_640_1136

Doc Status: No Doc

splash_screen_logo_top_offset

Setting: splash_screen_logo_top_offset

Doc Status: No Doc

stack

Setting: stack

Doc Status: No Doc

stacked_category_view

Setting: stacked_category_view

Doc Status: No Doc

start_scroll

Setting: start_scroll

Doc Status: No Doc

static_onboarding_cursor

Setting: static_onboarding_cursor

Doc Status: No Doc

std_button

Setting: std_button

Doc Status: No Doc

storefront_button_background

Setting: storefront_button_background

Doc Status: No Doc

storefront_button_text

Setting: storefront_button_text

Doc Status: No Doc

storefront_is_single

Setting: storefront_is_single

Doc Status: No Doc

storefront_order_now_image

Setting: storefront_order_now_image

Doc Status: No Doc

storefront_order_now_image_aspect

Setting: storefront_order_now_image_aspect

Doc Status: No Doc

storefront_show_search

Setting: storefront_show_search

Doc Status: No Doc

storefront_sort_by_server

Setting: storefront_sort_by_server

Doc Status: No Doc

storefront_subtitle

Setting: storefront_subtitle

Doc Status: No Doc

storesfront_sort_by_distance

Setting: storesfront_sort_by_distance

Doc Status: No Doc

sub_action

Setting: sub_action

Doc Status: No Doc

subcategories

Setting: subcategories

Doc Status: No Doc

tab_bar_black_icons

Setting: tab_bar_black_icons

Doc Status: No Doc

tabbar_color_red

Setting: tabbar_color_red

Doc Status: No Doc

tabbar_icon_color_red

Setting: tabbar_icon_color_red

Doc Status: No Doc

table_view_no_records_image

Setting: table_view_no_records_image

Doc Status: No Doc

tag_for_cat

Setting: tag_for_cat

Doc Status: No Doc

tagged_button_color

Setting: tagged_button_color

Doc Status: No Doc

tagged_button_icon_color

Setting: tagged_button_icon_color

Doc Status: No Doc

tagged_button_transform_color

Setting: tagged_button_transform_color

Doc Status: No Doc

tagged_nav_image_inset

Setting: tagged_nav_image_inset

Doc Status: No Doc

tagged_nav_show_lines

Setting: tagged_nav_show_lines

Doc Status: No Doc

tags

Setting: tags

Doc Status: No Doc

target

Setting: target

Doc Status: No Doc

tasks

Setting: tasks

Doc Status: No Doc

text

Setting: text

Doc Status: No Doc

text_blue

Setting: text_blue

Doc Status: No Doc

text_color_red

Setting: text_color_red

Doc Status: No Doc

text_green

Setting: text_green

Doc Status: No Doc

text_justify_center

Setting: text_justify_center

Doc Status: No Doc

text_red

Setting: text_red

Doc Status: No Doc

thisReview

Setting: thisReview

Doc Status: No Doc

thread_id

Setting: thread_id

Doc Status: No Doc

timer_id

Setting: timer_id

Doc Status: No Doc

title

Setting: title

Doc Status: No Doc

top

Setting: top

Doc Status: No Doc

top_label

Setting: top_label

Doc Status: No Doc

top_margin

Setting: top_margin

Doc Status: No Doc

topImageUrl

Setting: topImageUrl

Doc Status: No Doc

tos_content

Setting: tos_content

Doc Status: No Doc

track_location_on_home

Setting: track_location_on_home

Doc Status: No Doc

track_steps

Setting: track_steps

Doc Status: No Doc

track_unread

Setting: track_unread

Doc Status: No Doc

transform_image

Setting: transform_image

Doc Status: No Doc

transparent_search_background

Setting: transparent_search_background

Doc Status: No Doc

trigger_app_review

Setting: trigger_app_review

This will launch the App Store Review process after the user has opened the app the number of times specified in this setting. So to open the request for review after 20 app opens, set this setting to 20.

Doc Status: Private

tsl_sdk_manager

Setting: tsl_sdk_manager

Doc Status: No Doc

type

Setting: type

Doc Status: No Doc

unselected_gray

Setting: unselected_gray

Doc Status: No Doc

url

Setting: url

Doc Status: No Doc

Use an image in the Nav Header on the home screen

Setting: nav_header_image_view

This setting allows the user to specify an image to be used in the navigation header. If set to an image URL, then the image will be displayed in the navigation header. Wide, rectangular images work best.

This setting is available in the General Setting tab on the App Setting page.

Doc Status: Public

Use Camera

Setting: use_camera

If you are going to use the phone’s camera for photos, videos or QR Code scanning, then set this to yes. After turning this feature on, you must republish your app if you have already published it to Apple or Google.

This setting is available on the General Settings tab on the App Settings page.

Doc Status: Public

use_alt_homescreen_stack_first

Setting: use_alt_homescreen_stack_first

Doc Status: No Doc

use_alternative_tabbar

Setting: use_alternative_tabbar

Doc Status: No Doc

use_category_in_search_results

Setting: use_category_in_search_results

Doc Status: No Doc

use_dropdown

Setting: use_dropdown

Doc Status: No Doc

use_fine_location_filter

Setting: use_fine_location_filter

Doc Status: No Doc

use_geofilters

Setting: use_geofilters

Doc Status: No Doc

use_google_maps_for_directions

Setting: use_google_maps_for_directions

Doc Status: No Doc

use_indicator

Setting: use_indicator

Doc Status: No Doc

use_map_marker_images

Setting: use_map_marker_images

Doc Status: No Doc

use_matches_only

Setting: use_matches_only

Doc Status: No Doc

use_progress_meter

Setting: use_progress_meter

Doc Status: No Doc

use_rfid

Setting: use_rfid

Doc Status: No Doc

use_scrolling_home_screen

Setting: use_scrolling_home_screen

Doc Status: No Doc

use_stack_space

Setting: use_stack_space

Doc Status: No Doc

use_stacked_values

Setting: use_stacked_values

Doc Status: No Doc

use_tabs_for_homepage

Setting: use_tabs_for_homepage

Doc Status: No Doc

useGeofilterCenter

Setting: useGeofilterCenter

Doc Status: No Doc

user_avatar

Setting: user_avatar

Doc Status: No Doc

user_checked_in_information

Setting: user_checked_in_information

Doc Status: No Doc

user_display_name

Setting: user_display_name

Doc Status: No Doc

user_first_name

Setting: user_first_name

Doc Status: No Doc

user_last_name

Setting: user_last_name

Doc Status: No Doc

user_name

Setting: user_name

Doc Status: No Doc

user_tag_line

Setting: user_tag_line

Doc Status: No Doc

usergroups_selected

Setting: usergroups_selected

Doc Status: No Doc

userid

Setting: userid

Doc Status: No Doc

useTaggedNav

Setting: useTaggedNav

Doc Status: No Doc

value

Setting: value

Doc Status: No Doc

vc_type

Setting: vc_type

Doc Status: No Doc

videoUrl

Setting: videoUrl

Doc Status: No Doc

view_finder_image

Setting: view_finder_image

Doc Status: No Doc

visibility

Setting: visibility

Doc Status: No Doc

web_url

Setting: web_url

Doc Status: No Doc

website

Setting: website

Doc Status: No Doc

width

Setting: width

Doc Status: No Doc

wp_id

Setting: wp_id

Doc Status: No Doc

zoom

Setting: zoom

Doc Status: No Doc