Harbortouch API
Harbortouch is a point-of-sale (POS) platform for restaurants, bars, and retail. An unofficial API lets you programmatically pull orders/tickets, line items, payments and tips, batches/settlements, menu items and modifiers, inventory levels, employees and time entries, customers/loyal
What is Harbortouch?
Harbortouch is a POS solution (part of Shift4) that combines in-store terminals with the Lighthouse Business Management System (Lighthouse BMS) for back-office reporting and configuration. Restaurants and retailers use Harbortouch to manage orders and checks, route items to kitchen stations, process card and cash payments, track tips and settlements, manage menus and modifiers, handle inventory and vendors, run employee time clocks, and operate customer loyalty and gift cards.
Core product areas include:
- POS Operations (Orders/Tickets, Checks, Tables, Payments, Tips, Voids, Refunds, Batch Settlements)
- Menu & Pricing (Items, Categories, Modifiers/Groups, Taxes, Price Levels, Kitchen Routing)
- Inventory & Vendors (Items/SKUs, Stock Levels, Adjustments, Cost, Receive/Waste/Transfer)
- Workforce (Employees, Roles/Permissions, Time Clock, Shifts)
- Customer & Marketing (Customers, Loyalty Accounts, Gift Cards, Promotions/Discounts)
- Reporting (Sales, Labor, Taxes, Payment Batches)
Common data entities:
- Locations/Stores; Registers/Terminals
- Employees and Roles/Permissions
- Orders/Tickets (line items, modifiers, discounts, service type)
- Payments (tenders, tips, refunds); Batches/Settlements
- Menu Items, Categories, Modifier Groups, Tax Groups
- Inventory Items/SKUs, Stock Levels, Adjustments, Vendors
- Customers, Loyalty Accounts, Gift Cards, Promotions
The Harbortouch Integration Challenge
Operators rely on Harbortouch daily, but turning portal-based workflows into API-driven automation is non-trivial:
- Limited official API exposure: Many teams report relying on Lighthouse BMS exports (CSV) or partner-only integrations, with additional fees and constraints
- Real-time needs: Orders, payments, and menu changes need near real-time sync to delivery, KDS, and analytics; webhooks are sparse or unavailable
- Complex menu structures: Modifiers, price levels/dayparts, taxes, and kitchen routing can be intricate and vary by location
- Payment rigor: Tips, voids/refunds, and batch settlements must be reconciled carefully for accounting and compliance
- Role-aware data: Manager vs. cashier permissions and location scoping affect what’s visible and writable
How Supergood Creates Harbortouch APIs
Supergood reverse-engineers authenticated browser flows and network interactions to deliver a resilient API endpoint layer for your Harbortouch tenant.
- Handles username/password, SSO/OAuth, and MFA (SMS, email, TOTP) securely
- Maintains session continuity with automated refresh and change detection
- Normalizes responses so you can integrate once and rely on consistent objects across modules
- Aligns with customer entitlements and role-based permissions to ensure compliant access
Getting Started
- Schedule Integration Assessment
Book a 30-minute session to confirm your modules, licensing, and authentication model.
- Supergood Builds and Validates Your API
We deliver a hardened Harbortouch adapter tailored to your workflows and entitlements.
- Deploy with Monitoring
Go live with continuous monitoring and automatic adjustments as Harbortouch evolves.
API Endpoints
Authentication
/sessionsEstablish a session using credentials. Supergood manages MFA (SMS, email, TOTP) and SSO/OAuth when enabled. Returns a short-lived auth token maintained by the platform.
Authentication
/sessions/refreshRefresh an existing token to keep sessions uninterrupted.
Orders
/ordersList orders/tickets with filters and financial details.
Menu Items
/locations/{locationId}/menu/itemsCreate a menu item with categories, modifiers, pricing, and tax groups.
Payments
/orders/{orderId}/paymentsRecord a payment (card, cash, gift) and optional tip; optionally close the order.
Inventory Adjustments
/locations/{locationId}/inventory/items/{itemId}Adjust stock levels with reason codes for audits.
Use Cases
Sales & Operations Data Sync
- Mirror orders, line items, modifiers, and payments into your internal systems - Keep service type (dine-in, takeout, delivery), table status, and tips current for analytics - Normalize taxes, discounts, and batch settlements for multi-location reporting
Menu & Price Management
- Create and update menu items, categories, and modifier groups programmatically - Push daypart pricing and tax group changes across locations - Manage kitchen routing and printer groups for speed of service
Online Ordering & Delivery
- Sync menu, availability, and pricing to online ordering and delivery partners - Ingest orders and payment details to your OMS/KDS, update order statuses, and track fulfillment - Apply discounts and promos uniformly across in-store and digital channels
Labor & Time Clock
- Pull employee rosters and time entries for scheduling and payroll - Detect shifts and breaks, reconcile labor to sales for performance metrics
Accounting & Reconciliation
- Sync batches/settlements, tips, and refunds to accounting systems (e.g., QuickBooks, Xero) - Automate journal entries and daily sales summaries with tax breakdowns
Technical Specifications
Authentication
Username/password with MFA (SMS, email, TOTP) and SSO/OAuth where enabled; supports service accounts or customer-managed credentials
Response format
JSON with consistent resource schemas and pagination across modules
Rate limits
Tuned for enterprise throughput while honoring customer entitlements and usage controls
Session management
Automatic reauth and cookie/session rotation with health checks
Data freshness
Near real-time retrieval of orders, payments, menu, inventory, and workforce objects
Security
Encrypted transport, scoped tokens, and audit logging; respects Harbortouch role-based permissions and location scoping
Webhooks
Optional asynchronous delivery for long-running workflows (e.g., batch settlements, menu propagation)
Latency
Sub-second responses for list/detail queries under normal load
Throughput
Designed for high-volume order ingestion and menu/inventory updates across multi-location estates
Reliability
Retry logic, backoff, and idempotency keys minimize duplicate actions
Adaptation
Continuous monitoring for UI/API changes with rapid adapter updates
Frequently asked questions
Supergood supports workflows across commonly used modules such as POS Operations (Orders, Payments, Tips, Batches), Menu & Pricing (Items, Categories, Modifier Groups), Inventory (Stock Levels, Adjustments), Workforce (Employees, Time Clock), and Customer (Loyalty, Gift Cards), subject to your licensing and entitlements. We scope coverage during integration assessment.
We support username/password + MFA (SMS, email, TOTP) and can operate behind SSO/OAuth when enabled. Sessions are refreshed automatically with secure challenge handling.
Yes. We can normalize daily sales, tips, taxes, discounts, refunds, and batch settlements to match your ERP/accounting schema and deliver updates via webhooks or polling while complying with rate and permission constraints. We commonly integrate with QuickBooks and Xero.
Yes. Modifier groups, selection limits, price deltas, and kitchen printer routing are modeled explicitly in our normalized responses and write APIs, enabling consistent propagation across locations and channels.