Guides

Toast POS WordPress Documentation & Setup Guides

Learn how to install, configure and manage WP Toast Plugin with our complete Toast POS WordPress documentation. Follow step-by-step setup guides, connect the Toast API, customise restaurant menu layouts and troubleshoot common issues.
Get Started

Get Started in Minutes

New to ToastWP? Follow our quick setup guides to connect Toast, sync your menu, and publish your first layout.

Install & Activate

Install the plugin and access the ToastWP settings in WordPress.

Step 1

Connect Toast POS

Add your Toast Restaurant ID and Partner API credentials.

Step 2

Sync Your Menu

Import categories, items, modifiers, and pricing automatically.

Step 3

Choose a Template

Display your menu using templates and shortcodes.

Step 4

Documentation

Browse Documentation

Explore detailed guides for every feature.

Plugin Installation

1. Plugin Overview

Plugin Name: Restaurant Menu Sync for Toast
Description: Toast is a WordPress plugin that allows you to connect your website with an external API and manage features through your WordPress dashboard.
Version: 1.0.0
Author: Pankaj Verma

2. Requirements

To use the Toast plugin, make sure your server meets the following requirements:

  • WordPress Version: 5.5 or higher
  • PHP Version: 7.4 or higher

3. Installation

Method 1: Install from the WordPress Plugin Directory

  • Log in to your WordPress Admin Dashboard.
  • Navigate to Plugins → Add New.
  • Search for Toast.
  • Click Install Now.
  • After installation, click Activate.

API Settings

Step 1: Configure API Settings

After activating the plugin, configure the API settings to enable communication with the Toast platform.

  • Navigate to ToastTab Menu Dashboard → Settings → API Settings.
  • In the Sandbox Mode section, select the appropriate environment:
    • ON – Use Sandbox credentials for testing.
    • OFF – Use Live credentials for production.
  • If Sandbox Mode is disabled, enter the following details under Toast API Live Credentials:
    • Restaurant External ID
    • Client ID
    • Client Secret
    • User Access Type
    • Authentication URL
  • Click Test Live API Credentials to verify the connection.
  • If Sandbox Mode is enabled, enter the same details under Toast API Sandbox Credentials and click Test Sandbox API Credentials to verify.
  • Click Save Changes to store the configuration.
API Settings — Sandbox Mode and Live Credentials
API Settings — Sandbox Credentials

Step 2: Sync Menus

After saving the API settings, you need to synchronize your menu data from Toast POS.

Sync Menus tab
  • Go to the Sync Menus tab.
  • Click on Start Menu Item Synchronization.
  • Wait until the synchronization process is completed.

Step 3: Shortcode Integration

To display your Toast menu on any page or post, follow the steps below:

Shortcode tab
  • Go to the Shortcode tab in the Toast plugin dashboard.
  • Copy the provided menu shortcode.
  • Open the page or post where you want to display the menu.
  • Paste the shortcode into the WordPress editor.
  • Save or update the page.

Layout Settings

Configure General Settings

The General Settings section allows you to customize how menu items are displayed on the frontend.

General Settings panel
General Settings panel continued

Layout Options

  • Navigate to ToastTab Menu Dashboard → Settings → General.
  • Select the number of Menu Items Per Row from the dropdown list.
  • Choose the Image Placement option:
Above Content
Above Content layout
Aside Content
Aside Content layout

Select the Image Style:

Rounded
Rounded image style
Rectangle
Rectangle image style

Upload a Fallback Image to display when a menu item does not have an image.

Fallback image upload
Fallback image preview

Visibility Settings

Configure which menu item details should be visible to visitors:

Visibility Settings panel
Item Image
Item Image hidden preview
Item Title
Item Title preview
Item Description
Item Description preview
Item Tags
Item Tags preview
Item Price
Item Price preview

Use the Show or Hide toggle for each option.

Description Settings

Enter the desired Description Length. Select the length unit:

Characters
Characters length setting
Characters length preview
Words
Words length setting
Words length preview

This setting controls how much of the menu item description is displayed.

Interaction Settings

Choose how users interact with menu items:

Open in Lightbox – Opens item details in a popup window.
Open in Lightbox
Open in New Page – Opens item details on a separate page.
Open in New Page

Save Settings

After configuring all options, click Save Changes to apply the settings.

Reset Design and Style Settings

If you want to restore all layout and style settings to their original default values, click Reset Design/Style to Default.

Note: This action will reset the current template's layout and style configuration, including display, visibility, and description settings.
Expected Result: All customized design and style settings are reverted to the plugin's default configuration.

Style Settings

Configure Style Settings

Style Settings tab
Style Settings tab
Style Settings tab
Style Settings tab
Style Settings tab

The Style Settings section allows you to customize the appearance of menu items displayed on your website.

Global Styles

Choose how the plugin styling should be applied:

  • WordPress Theme – Uses the active theme's styling.
  • Plugin Settings – Uses the custom styles configured within the plugin.

Typography Settings

Customize the fonts used for different menu elements. Configure font families for:

  • Menu Wrapper
  • Menu Category Heading
  • Menu Item Title
  • Menu Item Description
  • Menu Item Tags
  • Menu Item Price

You can also specify font sizes (in pixels) for:

  • Menu Category Heading Size
  • Menu Item Title Size
  • Menu Item Description Size
  • Menu Item Tags Size
  • Menu Item Price Size

Color Settings

Customize the colors used throughout the menu display. Available color options include:

  • Menu Category Heading Color
  • Menu Item Title Color
  • Menu Item Title Hover Color
  • Menu Item Description Color
  • Menu Item Tags Text Color
  • Menu Item Tags Background Color
  • Menu Item Price Color
  • Menu Item Background Color
  • Menu Item Background Hover Color

Use the color picker beside each option to select the desired color.

Edge Settings

Select the corner style for menu items:

  • Sharp Corners – Displays square corners.
  • Rounded Corners – Displays rounded corners.

Save Settings

After making your changes, click Save Changes to apply the style configuration.

Reset Design and Style Settings

To restore all style and layout settings to their default values, click Reset Design/Style to Default.

Note: This action will remove all custom style configurations and restore the plugin's default appearance settings.
Expected Result: The menu display is updated according to the selected typography, color, layout, and custom CSS settings.

Select a Template

  • Navigate to ToastTab Menu Dashboard → Settings → Pre-Built Templates.
  • Browse the available menu templates.
  • Click on a template to preview and select it.
  • The selected template will be highlighted with a checkmark indicator.
  • Available template styles may include:
    • Glossy – Single Column
    • Classic – Two Columns
    • Classic – Two Columns (Dark)
    • Professional – Two Columns
    • Fancy – Two Columns

Apply the Selected Template

  • After selecting a template, click Apply Layout.
  • The selected template design will be applied to your menu display.
Note: Applying a pre-built template will override the current custom settings configured in the General Settings and Style Settings.

Reset Design and Style Settings

If you want to remove the applied template and restore the default appearance, click Reset Design/Style to Default.

Note: This action resets the current template's layout and style settings to their original default values.

Save and Verify

After applying a template, review your menu on the frontend to ensure the selected design matches your requirements.

Expected Result: The selected pre-built template is successfully applied, and the menu appearance is updated accordingly.

Browse Documentation

Explore detailed guides for every feature.

Setup & Config

Get your plugin installed and connected to Toast API in minutes.

Menu Sync

Learn how ToastWP pulls items, modifiers, pricing, and updates.

Templates

Browse available layouts, customize styles, and handle responsiveness.

Online Ordering (Pro)

Set up WooCommerce, cart flows, Spreedly payments, and store hours.

Advanced

Developer hooks, custom CSS, template overrides, and performance tips.

Popular Articles

How to get Toast Partner API credentials

Updated 2 days ago

Why my menu isn’t syncing

Updated 5 days ago

How often does ToastWP update menus

Updated 1 week ago

How to enable online ordering

Updated 3 days ago

Not sure where to begin?

We've grouped the most common starting points for you.

ToastWP Documentation and Guides
developer features

Built for Developers & Agencies

ToastWP includes developer-friendly tools for customization,
automation, and scaling across multiple restaurant sites.

Shortcodes

Powerful shortcodes to display menus anywhere.

Hooks & Filters

Extend and modify functionality with WordPress hooks.

Clean Codebase

Build using mordern standards for speed and reliability.

Need Help?

Contact our support team for setup help, bug reports, or account questions.

Quick Response

Expert Support

Found an Issue?

Check troubleshooting guides or report an issue directly.

Steps-by-Steps Guides

Easy to Follow

Solve Issue Faster

Last Step

Ready to Set Up Your Menu?

Set up your menu faster with automatic Toast sync and easy customization.

Real-time Updates

Changers reflect instantly

100% Reliable

Built for accuracy

Always in Sync

Every item, every time

Contact Support

Get help with setup, menu syncing, templates, or online ordering.
Contact Support

Report an Issue

Report a bug or unexpected behavior so we can fix it quickly
Report an Issue

Start Growing with Toast

Fill out the form below and our team will get back to you as soon as possible.

Contact Us Form
Tip: If reporting a sync issue, please include your Toast Restaurant ID.