Fields Index

Complete reference of all fields across all features. Use this to understand which field ID corresponds to which UI element in the backoffice.

See also: Options Reference - All toggle states and dropdown options

Quick Field Lookup

Location Settings

Field ID	Label	Type	Feature
name	Location Name	text	Locations
address.line1	Address Line 1	text	Locations
address.city	City	text	Locations
address.postal_code	Postal Code	text	Locations
address.country	Country	select	Locations
contact_information.email	Email	email	Locations
contact_information.phone	Phone	phone	Locations
preferred_language	Language	select	Locations
timezone	Timezone	select	Locations
average_prep_time	Prep Time (min)	number	Locations
snooze_time_out_of_stock_items	Snooze Duration	select	Locations

Business Hours

Field ID	Label	Type	Feature
business_hours.{day}.is_available	Day Available	toggle	Business Hours
business_hours.{day}.times	Time Ranges	array	Business Hours
restricted_dates	Restricted Dates	array	Restricted Dates
restricted_dates.*.date	Date	date	Restricted Dates
restricted_dates.*.yearly	Repeat Yearly	toggle	Restricted Dates

Online Ordering Settings

Field ID	Label	Type	Feature
takeout.enabled	Enable Pickup	toggle	Online Ordering
takeout.delay	Pickup Delay (min)	number	Online Ordering
delivery.enabled	Enable Delivery	toggle	Online Ordering
delivery.delay	Delivery Delay (min)	number	Online Ordering
custom_availability	Custom Availability	toggle	Online Ordering
accept_orders_until	Accept Orders Until	select	Online Ordering
schedule	Custom Schedule	schedule	Online Ordering
custom_scheduled_orders	Custom Scheduled Orders	toggle	Online Ordering
hours_in_advance	Hours in Advance	number	Online Ordering
minutes_before_pickup_delivery_time	Send to Kitchen Before	number	Online Ordering
idle_timeout_type	Timeout Type	select	Idle Timeout
idle_timeout_seconds	Timeout Duration	number	Idle Timeout
show_warning_for_seconds	Warning Duration	number	Idle Timeout
print_settings	Print Orders	select	Print Settings
send_to_pos	Send to POS	select	Print Settings
customer_information_full_name	Name Format	select	Customer Info
customer_information_contact_details	Contact Details	select	Customer Info

Delivery Settings

Field ID	Label	Type	Feature
delivery_region.type	Region Type	select	Delivery Settings
delivery_region.radius	Radius (km)	number	Delivery Settings
delivery_region.postal_codes	Postal Codes	array	Delivery Settings
delivery_fee.type	Fee Type	select	Delivery Settings
delivery_fee.fee	Delivery Fee	currency	Delivery Settings
delivery_fee.minimum_order_amount_for_free_delivery	Free Delivery Minimum	currency	Delivery Settings
delivery_fee.custom_fees	Custom Fees by Postal Code	array	Delivery Settings
minimum_order_amount.enabled	Minimum Order Enabled	toggle	Delivery Settings
minimum_order_amount.amount	Minimum Amount	currency	Delivery Settings

Pickup Settings

Field ID	Label	Type	Feature
pick_up_instructions.enabled	Enable Instructions	toggle	Pickup Settings
pick_up_instructions.placeholder	Instructions Text	text	Pickup Settings

Scheduled Orders

Field ID	Label	Type	Feature
schedule_order_for_future_days.takeout.enabled	Enable Scheduled Pickup	toggle	Scheduled Orders
schedule_order_for_future_days.takeout.days_in_advance	Pickup Days Ahead	number	Scheduled Orders
schedule_order_for_future_days.delivery.enabled	Enable Scheduled Delivery	toggle	Scheduled Orders
schedule_order_for_future_days.delivery.days_in_advance	Delivery Days Ahead	number	Scheduled Orders

Order Capacity

Field ID	Label	Type	Feature
order_capacity.time_slot_duration_min	Time Slot Duration	select	Order Capacity
order_capacity.limit_orders_per_time_slot	Limit Orders	toggle	Order Capacity
order_capacity.number_of_orders_per_time_slot	Orders Per Slot	number	Order Capacity
order_capacity.enable_flexible_limit_order_per_time_slot	Flexible Ordering	toggle	Order Capacity
order_capacity.allow_up_to	Flexible Limit	number	Order Capacity
order_capacity.value_threshold_per_time_slot	Value Threshold	currency	Order Capacity
order_capacity.limit_items_per_time_slot	Limit Items	toggle	Order Capacity
order_capacity.number_of_items_per_time_slot	Items Per Slot	number	Order Capacity
order_capacity.enable_limit_specific_categories	Category Limits	toggle	Order Capacity
order_capacity.limit_specific_categories	Category List	array	Order Capacity
order_capacity.time_specific_rules	Time Rules	array	Order Capacity
delivery_available_days	Delivery Days	array	Order Capacity
pickup_available_days	Pickup Days	array	Order Capacity

Tips & Notes

Field ID	Label	Type	Feature
collect_tips.enabled	Collect Tips	toggle	Tips
collect_tips.options	Tip Percentages	array	Tips
collect_tips.calculate_tips	Calculate Tips	select	Tips
allow_notes.enabled	Allow Notes	toggle	Order Notes
allow_notes.placeholder	Notes Placeholder	text	Order Notes

Menu Items

Field ID	Label	Type	Feature
name	Item Name	text	Menu Items
description	Description	textarea	Menu Items
price	Price	currency	Menu Items
category_id	Category	select	Menu Items
image	Image	image	Menu Items
status	Status	select	Menu Items
allergens	Allergens	multiselect	Allergens
dietary_preferences	Dietary Info	multiselect	Allergens
tags	Tags	multiselect	Allergens
tax_rate_code	Tax Rate	select	Menu Items
track_stock	Track Stock	toggle	Stock Management
stock	Stock Level	number	Stock Management
low_stock_threshold	Low Stock Alert	number	Stock Management

Modifiers

Field ID	Label	Type	Feature
name	Modifier Group Name	text	Modifiers
required	Required	toggle	Modifiers
min_selections	Min Selections	number	Modifiers
max_selections	Max Selections	number	Modifiers
modifiers	Modifier Options	array	Modifiers
modifiers.*.name	Option Name	text	Modifiers
modifiers.*.price	Option Price	currency	Modifiers
modifiers.*.default	Default Selected	toggle	Modifiers

Payment Settings

Field ID	Label	Type	Feature
viva_wallet.enabled	Enable Viva Wallet	toggle	Viva Wallet
viva_wallet.merchant_id	Merchant ID	text	Viva Wallet
viva_wallet.physical_source_code	Physical Source Code	text	Viva Wallet
viva_wallet.online_source_code	Online Source Code	text	Viva Wallet
stripe.live_mode	Stripe Live Mode (billing)	toggle	Stripe
stripe.account_id	Stripe Account ID (billing)	text	Stripe

Loyalty Program

Field ID	Label	Type	Feature
enabled	Enable Loyalty	toggle	Loyalty
points_per_currency	Points Per €	number	Loyalty
points_value	Point Value (€)	currency	Loyalty
welcome_bonus	Welcome Bonus	number	Loyalty
birthday_bonus.enabled	Birthday Bonus	toggle	Loyalty
birthday_bonus.type	Bonus Type	select	Loyalty
birthday_bonus.value	Bonus Value	number	Loyalty

Branding

Field ID	Label	Type	Feature
primary_color	Primary Color	color	Branding
secondary_color	Secondary Color	color	Branding
primary_text_color	Primary Text	color	Branding
secondary_text_color	Secondary Text	color	Branding
primary_background_color	Primary Background	color	Branding
secondary_background_color	Secondary Background	color	Branding
heading_text_font	Heading Font	select	Branding
body_text_font	Body Font	select	Branding
slogan	Slogan	text	Branding
short_description	Description	textarea	Branding
social_links	Social Links	array	Branding

Receipt Settings

Field ID	Label	Type	Feature
show_order_level_discounts_on_item_level	Show Discounts	toggle	Receipts
show_tax_summary	Show Tax Summary	toggle	Receipts
show_price	Show Prices	toggle	Receipts
show_address	Show Address	toggle	Receipts
display_contact_information	Show Contact	toggle	Receipts
display_qr_code	Show QR Code	toggle	Receipts
display_qr_code_applies_to	QR Code Type	select	Receipts
custom_footer_text	Custom Footer	toggle	Receipts
custom_footer_title	Footer Title	text	Receipts
custom_footer_long_text	Footer Text	textarea	Receipts

KDS Settings

Field ID	Label	Type	Feature
layout	Layout	select	KDS
filter.order_source.all	All Sources	toggle	KDS
filter.order_source.kiosk	Kiosk Orders	toggle	KDS
filter.order_source.online_ordering	Online Orders	toggle	KDS
orders.strike_through_individual_modifier	Strike Through	toggle	KDS
orders.reset_timer_on_recall	Reset Timer	toggle	KDS
orders.automatically_hold_scheduled_orders	Hold Scheduled	toggle	KDS
timers.for_here.caution_time_seconds	For Here Caution	number	KDS
timers.for_here.late_time_seconds	For Here Late	number	KDS
timers.pickup.caution_time_seconds	Pickup Caution	number	KDS
timers.pickup.late_time_seconds	Pickup Late	number	KDS
sound.mute_order_sound	Mute Sounds	toggle	KDS
sound.volume	Volume	number	KDS

Integrations

Field ID	Label	Type	Feature
square.connected	Square Connected	toggle	Square
square.location_id	Square Location ID	text	Square
square.sync_menu	Sync Menu	toggle	Square
square.sync_orders	Sync Orders	toggle	Square
deliveroo.enabled	Enable Deliveroo	toggle	Deliveroo
deliveroo.restaurant_id	Restaurant ID	text	Deliveroo
deliveroo.auto_accept	Auto Accept	toggle	Deliveroo
uber_eats.enabled	Enable Uber Eats	toggle	Uber Eats
uber_eats.store_id	Store ID	text	Uber Eats
uber_eats.auto_accept	Auto Accept	toggle	Uber Eats

Field Documentation Template

Each field should include:

### Field Name
| Property | Value |
|----------|-------|
| **Field ID** | `snake_case_id` |
| **Label** | Human-readable label |
| **Type** | text/number/toggle/select/array/etc. |
| **Default** | Default value |
| **Required** | Yes/No |
| **Validation** | Validation rules |
| **Depends On** | Parent field (if conditional) |

**Description**: What this field does.

**Business Logic**: How it works internally.

**Customer Impact**:
- **Online Ordering**: Effect on OO
- **Kiosk**: Effect on Kiosk

**Examples**: Real-world usage examples.

**Troubleshooting**: Common issues with this field.

Field Types

Basic Types

• text - Single line text input
• textarea - Multi-line text input
• number - Numeric input
• currency - Money amount
• toggle - Boolean on/off
• checkbox - Boolean with label
• select - Dropdown selection
• multiselect - Multiple selection

Complex Types

• array - List of items
• object - Nested fields
• date - Date picker
• time - Time picker
• datetime - Date and time
• daterange - Date range
• timerange - Time range
• color - Color picker
• image - Image upload
• file - File upload

Special Types

• address - Address with autocomplete
• phone - Phone number with validation
• email - Email with validation
• url - URL with validation
• schedule - Weekly schedule
• json - Raw JSON editor

Statistics

• Total Fields Documented: 150+
• Categories: 15
• All fields link to detailed feature documentation

How Emily Uses This

When a merchant asks about a setting, Emily can:

1. Find the field by searching this index
2. Understand the type (toggle, select, number, etc.)
3. Link to full documentation for detailed explanation
4. Explain customer impact from the feature docs

Example Usage

Merchant asks: "How do I limit orders during lunch rush?"

Emily looks up: order_capacity.time_specific_rules → links to Order Capacity

Emily explains: "You can create time-specific rules in Order Capacity settings. Go to In-House Settings, scroll to Time Specific Rules, and add a rule for your lunch hours with custom order limits."