Interact Mobile User Guide

  • Updated
Follow

About Interact Mobile

Interact Mobile is a RESTful API that allows our customers and partners to integrate their web and mobile applications seamlessly with the Appetize ecosystem. Interact Mobile provides a custom solution by leveraging the content, payment, and venue/vendor configuration tools already present in Connect.          

Note: Interact Mobile must be enabled by Appetize. Please contact Support for more information.

Interact Mobile Settings

Once Interact Mobile is enabled, you can manage all of your content in Connect, just as you do for Activate or Interact Kiosk.

Adding a Venue Image

Venue images are returned for each enabled Venue.

  1. In Connect, click Settings > Venue.
  2. On the Venue page, under Venue Image, click the + symbol to add an image.
  3. In the file browser window, click the image you want to upload, and then click Open.
  4. Click Save Changes.

Vendor Roles

A Vendor Role is a group of settings used to configure the Interact Mobile options for a specific vendor.

Creating Vendor Roles

A Vendor Role should be created for each Vendor. After the Vendor Role is created, Vendors can be created and assigned to the Vendor Role.

For instructions on how to create a Vendor Role, please reference Vendor Roles.

Configuring Vendor Roles

After the Vendor Role is created, the Interact Mobile settings must be set.

Adding a Vendor Role Image

The Vendor Role image is returned with the Vendor call within Interact Mobile.

  1. In Connect, click Options > Vendor Roles.
  2. On the Vendor Roles page, under Vendor Image, click the arrow symbol to add an image.
  3. In the file browser window, click the image you want to upload, and then click Open.
  4. A notification message will display on the top-right of the Vendor Roles screen if the save is successful.

Note: The vendor image displays in the Web portal if the guest has the option to select a vendor.

Setting the Vendor Status

  1. In Connect, click Options > Vendor Roles.
  2. On the Vendor Roles page, under the Open column, click Yes (Open) or No (Closed).
    • Open: Users can order items from the vendor. 
    • Closed: The vendor is hidden on the app.

Setting Vendor for Pickup or Delivery

The POS Pickup Vendor option should be set to pickup or delivery for Vendors.

  1. In Connect, click Options > Vendor Roles.
  2. On the Vendor Roles page, click the Vendor Role you want to configure.
  3. Under the POS Pickup Vendor option, click the pencil icon, and then click an option.
    • Yes: This vendor is set for Pickup.
    • No: This vendor is set for Delivery.

Configuring Alcohol Limitations

You can configure alcohol limitations for each location.

  1. In Connect, click Options > Vendor Roles.
  2. On the Vendor Roles page, click the Vendor Role you want to configure.
  3. Click the Alcohol tab. Select the required options.
    • Alcohol Enabled: Governs whether or not the vendor is able to sell alcoholic beverages.
    • Drink Limit Per Event: Ability to set a specific amount of alcohol sales by item quantity.
    • Drink Limit Per Order: Ability to set a limit to the number of alcohol items per order.
    • Limit Amount Per OrderAbility to set the specific amount of alcohol item sales per order.

Configuring Mobile Ordering Options

Each vendor can have customized settings for mobile ordering.

  1. In Connect, click Options > Vendor Roles.
  2. On the Vendor Roles page, click the Vendor Role you want to configure.
  3. Click the Mobile Ordering Options tab. Select the required options.
    • Wait Time: Enter the time interval (in minutes) in which an automated text message would be sent to the customer once the status of an order change to ‘In Progress.’
    • Pickup Vendor: Click Yes if the vendor allows order pickups.
    • Pickup Text Message: Enter a custom message that includes pickup details that will be sent to customers. 
    • Pickup Location: Enter a pickup location. Once the order is ready, a text will notify the customer of where to pick up their order.
    • Type: Select if the vendor sells merchandise or concessions.

Configuring Mobile Ordering Fee and Tip Options

Each vendor can have customized settings for fees and tips.  

  1. In Connect, click Options > Vendor Roles.
  2. On the Vendor Roles page, click the Vendor Role you want to configure.
  3. Click the Mobile Ordering Transactions tab. Select the required options.
    • Convenience Fee: Click Yes to turn on a surcharge or delivery amount.
    • Fee Type: Select a fee type: Percentage or Flat Fee.
    • Fee Amount: Enter the amount of the desired fee.
    • Fee Text: Enter an explanation of the fee for customers.
    • Tip Enabled: Click Yes to give customers an option to leave a tip for the employees.
    • Require Seat Confirmation: Click Yes to prompt customers to confirm their seat selection after placing an order. 

Mobile Vendors

Mobile Vendors must be created to set menus for a specific location, identify what areas of the venue it serves (if your venue has an associated layout), and to establish KDS routing to kitchens.

Creating Vendors

A Vendor is a location that is reconciled as a single revenue center. Please reference How to Create a Vendor.

Note: Remember to add the corresponding Mobile Ordering Vendor Role.

Adding Tax Groups for Venues

Tax Groups can be created and applied to a Vendor Role once the Tax Rate is active. To add Tax Rates and Groups, please reference Tax Per Item: Tax Rates and Tax Groups.

Configuring taxes for Venues

Taxes can be applied to a Vendor Role so the tax will apply to the associated Vendors.

  1. In Connect, click Options > Vendor Roles.
  2. On the Vendor Roles page, click the Vendor Role you want to configure.
  3. Select the Tax Group tab.
  4. Select Assign Tax Group to add the previously created tax group with a tax rate assigned.
  5. Now all items sold through the vendors assigned to the Vendor Role will be taxed at that rate. 

Layouts

A Layout is used to program a seating arrangement and associated vendors into Connect. These settings can then be utilized by Interact Mobile clients, allowing their users to enter their seat assignment, and present them only with the appropriate vendors for ordering.

Note: The system creates a Default Layout upon setup. All programming will correspond to this layout by default. The name of this layout can be changed if needed. 

Creating Layouts

If only one layout is needed, you can edit the existing Default Layout. If multiple layouts are needed, you can create additional layouts. To create a new Layout, please reference How to Create and Edit Layouts.

Assigning Seating Charts to Vendors

Once the Levels have been created they can be assigned to their respective vendor.  

  1. In Connect, click Vendors.
  2. On the Vendors page, click the Vendor you want to modify.
  3. Click the Serves tab.
  4. Select a Level to enable for this vendor.  Multiple levels may be enabled per vendor.
  5. Select the specific rows and seats associated with the vendor or select Check All.
  6. Click Save Changes. 

Items

Items are the goods (food, drink, and merchandise) that are sold through Interact Mobile. Items can be assigned to specific Vendors. Please reference How to Create and Edit Items in Connect for instructions on adding and assigning items.

Creating Modifiers

Create Modifiers for Items that have custom options. Those options can be selected when a user purchases an item (e.g., a modifier for a cheeseburger could be the type of cheese). Modifiers can be assigned to an Item at a specific Vendor. To create Modifiers, please reference the Item Modifier article.

Modifiers Tab

Each item that has modifiers can determine how to handle the additional items during the checkout process.

  • Require Modifiers: Click Yes if a modifier is required. Click No if a modifier is optional.
  • Modifier Price Override: Determines if there is an additional charge for the modifier.
    • Select Yes if the price of a Modifier overrides the original price of parent item (e.g., if a burger started at $0 and the type of patty determines the cost).
    • Select No if the modifier adds to the price of the item. (e.g., if a burger started at $7 and you have the option of making it a bison burger for $3 extra, it would turn into a $10 burger).
  • Restrict Single Modifier: Click Yes to allow only one modifier from the Modifier list to be selected.
  • Custom Vendor: Set if a modifier is only offered at certain Vendors.

Here’s an example:

Assigning Items to Vendors

Items can be individually assigned to a Vendor.

To assign an item to a vendor

  1. In Connect, click Items > Items.
  2. On the Items page, click the Item you want to assign to a vendor.
  3. Click the Assigned Vendors tab.
  4. Click Add Vendor to assign the item to a vendor.

  5. In the Add Vendor window, click to Assign/Unassign Vendors.

Note: Items can be assigned to multiple vendors and subvendors.

Adding Promo Codes

Currently, Promo Codes are not exposed via the API.

Add a Promo Code if you want to apply the following types of discounts to orders or items:

  • Percentage off
  • Flat dollar amount off
  • Full comp

To add a Promo Code, please reference How to Create Codes/Promos.

To enable Promo Codes on a Vendor Role

  1. In Connect, click Options > Vendor Roles.
  2. On the Vendor Roles page, under the Promo Enabled column, click Yes (Enabled) or No (Disabled).

 

Related articles