Skip to main content

Custom Integrations

Overview​

The Lightspeed Restaurant (K-Series) API is a powerful tool designed to enable secure data exchange between your systems and your restaurant environment. This REST API adheres to standard REST principles and uses robust OAuth2 authentication.

Lightspeed customers with an internal development team can create custom integrations tailored to their organization’s specific needs. These integrations enable seamless connectivity with internal systems and are typically developed and maintained by in-house developers or trusted technology partners.

To get started, request API access through your Lightspeed account manager.

Custom Apps vs. Public Integrations​

TypeDescription
Custom AppBuilt specifically for your business. Allows tailoring connectivity to your unique workflows, systems, and operational model.
Public IntegrationPre-validated apps available through Lightspeed's Integration Hub. Lightspeed offers over 150 validated apps.

A custom app is built specifically for your business and is not listed or distributed through the Lightspeed Marketplace. Custom apps are designed to meet your internal workflows and operational needs without being shared or used by other merchants.

Custom apps are:​

  • Exclusive to the business they are built for (including franchise locations, if applicable)
  • Not permitted to be resold, commercialized, or offered to other Lightspeed merchants unless you have a formal partnership agreement with Lightspeed

If your goal is to build an integration for multiple merchants or to commercialize your solution, join the Partner Program.

If you prefer not to build your own integration, explore the Integration Hub.

Available API Endpoints for Custom Integrations​

Custom integrations currently have access to the following endpoints:

Financial API​

Provides complete accounting export data, including:

  • Revenue summaries
  • Taxes
  • Discounts
  • Payments
  • Accounting period breakdowns

Used for integrations with accounting, financial reporting, and ERP systems.

Documentation

Items API​

Provides menu item data, including:

  • Item names
  • Pricing information
  • Identifiers
  • Configuration details

Used for syncing product catalogs with online ordering, inventory, or eCommerce platforms.

Documentation

Real-Time Notifications and Webhooks​

Real-Time Notifications (RTN) and webhooks are not supported for custom integrations.

To deliver near real-time data, your application must:

  • Query the API on demand, or
  • Poll at regular intervals (e.g., hourly)

Getting Access to the API​

  1. Review the API documentation to confirm your requirements are supported
  2. Contact your Lightspeed Account Manager
  3. Request access to the K-Series API
  4. Complete the technical contact form
  5. Receive API credentials via email

Demo Account and API Credential Provisioning​

All endpoints are read-only, so production API credentials are provided by default. This ensures access to real data structures and environments.

Demo Account Notes:​

  • No pre-filled data
  • Developers must:
    • Create menu items
    • Run test orders
    • Generate sales data

Request a demo account during the API access process if needed.

API Client Policy​

Lightspeed provides one API client per business account.

This client supports:

  • Financial data retrieval
  • Menu synchronization across locations

Restrictions​

  • Credentials cannot be resold, shared, or redistributed
  • One client per business account
  • Multiple locations connect via OAuth under the same client

API Design​

  • Read-only endpoints
  • Optimized for efficient data retrieval
  • Designed for single-client usage

Development and Testing​

  • Production integrations must use the same API client
  • Staging client and demo account available upon request

Note: API client provisioning or updates can take up to 48 hours.

Important Documentation Resources​

Authentication Overview​

The K-Series APIs use OAuth2 for authentication and authorization.

Flow​

  1. Redirect user to authorization page
  2. User grants permission
  3. Receive authorization code
  4. Exchange code for:
    • Access token
    • Refresh token
  5. Use access token for requests and refresh as needed

Tutorial

Support During Development​

The Integration Specialist team can assist with:

  • API behavior and functionality clarification
  • Reviewing API requests and responses
  • Directing you to relevant documentation
  • Logging bugs and enhancement requests

API Support Scope​

Included​

  • API clarification
  • Documentation guidance
  • Issue investigation (API-side)

Not included​

  • Code debugging or modification
  • System architecture design
  • End-user support for your integration
  • Live or video support (email only)

For product or Back Office questions, contact K-Seriessupport.