A later API version is available

This documentation is applicable to V1 of the gateway which will still exist. If you wish to integrate with Table Tracker, we recommend reading the [V2 documentation](🔗) or contact [LRSUS](🔗) for more information.

**Table Tracker** is a table location system that identifies where guests are sitting so you can deliver food faster. A key component of the Table Tracker system, the _Table Tracker Gateway_ is a small, on-premise device. It interfaces with iOS Table Tracker, but also supports access via a REST API.

## How Does it Work?

A Tracker is given to customers when they order.The Tracker reads tags on the customer's table and broadcasts its location.Food runners reference the Order View to identify a guest's location and deliver food.Managers can use the Table Tracker app or LRS Connect to view performance reports.

Orders represent a customer interaction and have the following properties:

  • Identified by numbers, such as 1, 2, 3,... that are assigned and associated with a Tracker.

  • Move through states such as **started**, **located** and **cleared**.

  • Have an order type of `ON_PREMISE` or `TO_GO` and can change types.

  • A `TO_GO` order will still be located when a customer places the Tracker on a table while waiting on their order.

  • Orders can be paged to notify a customer that their `TO_GO` order is ready for pickup.

## Supported Operations

The Table Tracker Gateway API provides all the necessary methods to implement an solution equivalent to the iOS Table Tracker application.

With the API, you can:

  • Start, Locate, Page and Clear active orders.

  • Search for all Active Orders.

  • Register a REST endpoint to be notified when the status changes for any Active Order.

  • Search Order History for reporting or tracking purposes.

  • Query daily order statistics to measure average delivery times against a goal.

## Authentication

Authentication is handled via basic authentication. Each request must be authenticated via a key provided by LRS during implementation. The system uses the Basic Authentication mechanism.

Use API key as the username and blank for the password. **Do not forget the colon at the end.** base64("API_key:")

## SSL

This manner of authentication is only secure if SSL is employed everywhere.

## Discovery Service

The Gateway discovery mechanism provides a way of dynamically discovering devices that are capable of interacting with the Gateway. The discovery protocol is an implementation of [Bonjour](🔗). The Gateway advertises the service type of `_tracker-http._tcp`.