← Back to all docs

Heartland Restaurant API

Heartland Restaurant is an all-in-one restaurant point-of-sale and management platform—a Global Payments company—covering POS terminals, built-in online ordering, kitchen display, loyalty, gift cards, payments, inventory, and reporting. An unofficial API lets you pull orders, checks, payments, menu items, guest and loyalty profiles, gift cards, and inventory—and push updates like menu changes, online orders, and loyalty adjustments back into Heartland Restaurant.

By Alex Klarfeld•May 30, 2026
Heartland Restaurant API

What is Heartland Restaurant?

Heartland Restaurant is a modern restaurant point-of-sale and management platform from Heartland, a Global Payments company (NYSE: GPN). It combines payment processing, built-in online ordering, a kitchen display system, loyalty, gift cards, inventory, and reporting in one system, and supports over 130 native integrations across marketing, accounting, inventory, and property management. Restaurants—from fine dining to quick-service—use it to take dine-in, kiosk, guest-app, online, and third-party-delivery orders that all sync to a single point of sale.

Core product areas include:

  • Point of Sale (terminals, self-order kiosk, and guest app ordering)
  • Built-in Online Ordering and third-party delivery sync
  • Kitchen Display System (KDS) with real-time order routing to stations
  • Loyalty and customer engagement
  • Gift Cards (integrated with Heartland, Mercury, and Valutec programs)
  • Inventory, sales reporting, and analytics
  • Table management and waitlist tools for fine dining

Common data entities:

  • Orders, Checks, Tickets, Line Items, Modifiers
  • Payments, Tips, Refunds, Gift Cards
  • Menu Items, Categories, Modifiers, 86 status
  • Guests, Loyalty Members, Loyalty Points and Rewards
  • Employees, Time Cards, Server and Station assignments
  • Inventory Items, Counts, Tables, Reservations and Waitlist

The Heartland Restaurant Integration Challenge

Restaurants run live service on Heartland Restaurant every day, but turning POS- and app-driven workflows into API-driven automation is non-trivial:

  • No public developer API: Heartland Restaurant exposes its data through the POS, dashboards, and a partner integration program rather than open, self-serve API documentation
  • Partner-gated access: Many capabilities flow through the 130+ native integration program, requiring partnership agreements before data access
  • Multi-channel order spread: Dine-in, kiosk, guest app, online ordering, and third-party delivery orders all converge in one POS with different shapes and lifecycle states
  • Real-time service constraints: KDS routing, 86s, and check changes happen live during service and need low-latency, reliable handling
  • Payments and gift-card sensitivity: Payment, tip, and gift-card data (Heartland, Mercury, Valutec) demand careful, compliant handling
  • Per-location configuration: Menus, modifiers, pricing, and loyalty rules vary by location, so generic integrations break across a multi-unit operator

How Supergood Creates Heartland Restaurant APIs

Supergood reverse-engineers Heartland Restaurant's authenticated browser and app flows to deliver a resilient, production-grade API layer for your locations—without waiting on a public API or a partner-program gate.

  • Handles username/password and MFA securely in a managed session
  • Maintains session continuity with automated refresh and change detection
  • Normalizes orders, checks, payments, menu, loyalty, and inventory into consistent objects so you integrate once across all locations
  • Aligns with per-location menus, modifiers, pricing, and loyalty rules to keep responses accurate across a multi-unit operator

Use Heartland Restaurant with AI agents: Heartland Restaurant MCP Server →

Getting Started

  • Schedule Integration Assessment

Book a 30-minute session to confirm your locations, modules, and authentication model.

  • Supergood Generates and Validates Your API

We deliver a production-ready Heartland Restaurant adapter tailored to your menu, payment, and loyalty configuration.

  • Deploy with Monitoring

Go live with continuous monitoring and automatic adjustments as Heartland Restaurant evolves.

heartland

API Endpoints

Authentication

POST/authenticate

Authenticate to a Heartland Restaurant account using username/password or MFA and obtain a session token for downstream calls.

Orders

GET/orders

List orders and checks across dine-in, kiosk, guest app, online, and third-party delivery channels with status, location, and date filters.

Orders

POST/create_order

Create or submit an order with line items, modifiers, and customer details routed to the appropriate location and KDS station.

Payments

GET/payments

Retrieve payments, tips, refunds, and gift-card transactions tied to checks across locations.

Menu

GET/menu_items

Pull menu items, categories, modifiers, pricing, and 86 status for a location.

Loyalty

GET/loyalty_members

Retrieve loyalty members, points balances, and reward activity for guest engagement workflows.

Use Cases

Sync orders and sales data into your warehouse

- Pull orders, checks, and line items across dine-in, online, kiosk, and delivery channels into a single warehouse - Stream payment, tip, and refund events to downstream BI and accounting tools - Reconcile multi-location sales for unified operator reporting

Automate menu and 86 management

- Push menu, modifier, and pricing changes across locations without manual POS entry - Sync 86 status in real time so out-of-stock items disappear from online ordering and kiosks - Pull current menu state for consistency checks across a multi-unit operator

Power loyalty and guest engagement

- Pull loyalty members, points, and reward activity into your CRM and marketing tools - Push loyalty adjustments and rewards back into Heartland Restaurant - Trigger campaigns from purchase frequency and spend signals

Reconcile payments and gift cards

- Sync payments, tips, and refunds into general ledger and reconciliation systems - Track gift-card balances and redemptions across Heartland, Mercury, and Valutec programs - Match daily settlement against POS checks for each location

Technical Specifications

Authentication

Username/password and MFA handled in a managed session

Connectivity

Authenticated browser and app flows reverse-engineered from the Heartland Restaurant POS and dashboards

Response format

Normalized JSON across Orders, Payments, Menu, Loyalty, and Inventory objects

Rate limits

Adaptive throttling tuned per location to avoid platform-side limits

Session management

Automatic session refresh, MFA replay handling, and credential rotation

Data freshness

Near real-time pulls for orders, payments, and menu state with optional scheduled batch syncs

Security

Encrypted credential vault, scoped access tokens, SOC 2-aligned controls, and audit logging

Webhooks

Event-style callbacks for new orders, payments, 86 changes, and loyalty activity

Latency

Sub-second reads on cached entities; multi-second writes when submitting orders and menu changes

Throughput

Horizontally scaled workers sized to multi-location, peak-service order volume

Reliability

Retry, backoff, and idempotency keys for order submission, payments, and menu updates

Adaptation

Continuous monitoring of Heartland Restaurant releases and per-location configuration drift

Frequently asked questions

Heartland Restaurant does not offer open, self-serve API documentation; data flows through the POS, dashboards, and a partner integration program. Supergood provides a stable, unofficial API layer over your authenticated Heartland Restaurant access so you can automate without a partner gate.

Yes. Supergood normalizes orders, menu, payments, and loyalty across locations and respects each location's menus, modifiers, pricing, and loyalty rules, so a multi-unit operator integrates once.

Yes. Because dine-in, kiosk, guest app, online ordering, and third-party delivery orders all converge in the Heartland Restaurant POS, the API surfaces them through a single normalized order model.

Payments, tips, refunds, and gift-card transactions—including Heartland, Mercury, and Valutec gift-card programs—are exposed through the normalized API with compliant, scoped access and audit logging.

Supergood continuously monitors Heartland Restaurant releases and per-location configuration drift, automatically adjusting the adapter so your integration keeps working without manual maintenance.

Related APIs in POS / Hospitality

POS / Hospitality

HotSchedules API

HotSchedules (by Fourth) is a workforce management platform built for restaurants and hospitality, powering scheduling, labor forecasting, compliance, payroll, and shift communication across 120,000+ locations. An unofficial API lets you programmatically pull schedules, shifts, employee records, labor productivity, and time & attendance data—and push sales imports and roster updates back into HotSchedules.

POS / Hospitality

Korona POS API

KORONA POS is a cloud-based, all-in-one point of sale platform for retail, quick-service restaurants, and ticketing venues, covering inventory, CRM and loyalty, payments, and multi-location management. The KORONA Cloud API v3 lets you programmatically pull products, inventory, sales receipts, customers, and supplier records—and push updates like new products, price changes, and stock adjustments back into a KORONA account.

POS / Hospitality

Lavu POS API

Programmatically access Lavu POS restaurant data, menus, orders, payments, and labor reporting with a stable REST API. Supergood builds and operates production-grade, unofficial Lavu integrations so your team can automate front-of-house and back-of-house workflows without heavy custom engineering. P

POS / Hospitality

Lightspeed POS API

Lightspeed POS is cloud-based point of sale software for retail stores, restaurants, and golf operations. An unofficial API lets you programmatically pull products and variants, stock levels by location, suppliers, customers and loyalty balances, sales and refunds, payments and shifts—and push updates like stock adjustments, purchase orders, menu changes, and new customers back into Lightspeed.

POS / Hospitality

Lightspeed Restaurant API

Lightspeed Restaurant is a cloud point-of-sale platform for hospitality, powering ordering, payments, inventory, kitchen display, reservations, and analytics across more than 144,000 locations. An unofficial API lets you programmatically pull menus, orders, checks, payments, customers, inventory, and sales data—and push updates like new orders, menu changes, and reservations back into Lightspeed Restaurant.

POS / Hospitality

Lunchbox API

Lunchbox is an enterprise restaurant technology platform unifying web and app ordering, B2B catering, order aggregation, marketing CRM, loyalty, and payments across multi-location operations. Its Open API lets you programmatically retrieve locations, menus, and guest accounts, place orders directly into the POS, and receive delivery and order events via webhooks—so you can pull order, menu, and guest data and push new orders and menu updates back into Lunchbox.

Ready to get a real API?