API Platform Overview

Data Management

Use the Data Management API to create and review menu items, products, product-prices, taxes, discounts, and other business details. Use the Data Management API to obtain the site identifiers and item numbers required to create and process orders.

{{dm_url}}

Online Ordering

Use the Online Ordering API to create orders, add payment methods, and send the orders to locations for processing. The Online Ordering API provides a complete online ordering experience including tax and discount calculations. It also includes order injection from our Cloud.

{{xoo_url}}

{{mo_url}}

Menu Engine

Menu Engine API provides the menu and calculated price data needed to keep an online menu up to date. It exposes menus in Data Management to integrators.

{{xme_url}}

Chef Kitchen Management

Chef Kitchen Management API provides the Chef Reporting and Local Sales APIs for transactional data.

Digital Menu Board

Digital Menu Board API presents dynamic and vivid graphics and video elements to guests at the counter and at the drive thru.

{{distributor_url}}

Genius Drive Thru

Genius Drive Thru is a customer-facing API that supplies drive thru event data.

{{dtd_url}}

Omni-Channel Ordering

Omni-Channel Ordering allows third parties and affiliates to communicate with our suite products.

{{omni_url}}

Back Office

Back Office serves multi-unit restaurant brands and franchisees, often in the Quick Service Restaurant (QSR) and Fast Casual Restaurant markets.

{{bo_url}}

Portal

Portal API is the first administration layer of the our Cloud product suite. The Portal establishes access to all of our other Cloud components.

{{portal_ui_url}}

Staff

Staff API provides a set of resources used to manage employee records, schedules, payroll, and other typical back office functions. It allows employees to be injected into the integrator's system.

{{boh_staff_ui_url}}

Data Stream

Data Stream API publishes JSON formatted objects to a configurable webhook URL so that integrators and customers can use the data in business management or analysis software outside of our system. Data Stream API is a real-time data feed straight from Pipeline.

{{whstd_url}}

Gift and Loyalty

Gift and Loyalty API adds support for gift card payments and loyalty programs to existing point of sale (POS) devices and applications. Gift and Loyalty API acts as a middleware between gift and loyalty providers and underlying POS systems.

{{xgl_url}}

Genius Kitchen

Genius Kitchen API supports a fully-featured kitchen management system that enables the kitchen staff to serve guests both timely and accurately.

{{xkm}}

Notification

The Notification service provides customers and integrators the ability to subscribe to notifications about changes to a specific company's orders and data.

{{xssn_url}}

Payment Router

Payment Router handles accumulative order features, such as creating a bar tab. Payment Router API acts as a middleware service between payment providers and underlying POS systems.

{{xpr_url}}

Pipeline

The Pipeline service supports data transfer between components of the Portal API and external integrators, including POS API.

Reporting

Use Reporting API to access all reporting for each of the Portal API modules. Reporting API is ideal for the pulling of reporting data once a day.

{{reporting_api_url}}

Venue Inventory

Venue Inventory API provides the venues-based inventory controls required to order, receive, and transfer product, track on-hand quantities, track cost, and perform stand worksheet end counts.

{{XVI_url}}

Classic Portal API

The Class ic Portal API includes operations for generating the tokens used to authenticate the application with the our suite. The Classic Portal API operations also create companies and sites, set roles and permissions, and integrate with our other products.

{{portal_url}}