Custom Integrations

Overview

The Lightspeed Restaurant K-Series APIs enable secure data exchange between external systems and your restaurant environment. They follow standard REST principles and use OAuth 2.0 for authentication.

Merchants with an internal development team or a trusted third-party developer can build custom integrations tailored to their business — connecting K-Series to internal tools, reporting platforms, or operational workflows.

Custom API access is a paid add-on. To get started, contact your Lightspeed Account Manager.

note

Custom integrations are developed and maintained by you or your developer — not by Lightspeed. You are responsible for implementation, testing, and ongoing support of your integration.

Custom Apps vs. Approved Integrations

A custom app is built exclusively for your business. It is not listed in the Lightspeed Marketplace and cannot be shared with 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.

An Approved Integration is a pre-validated app available through Lightspeed's Integration Hub. Lightspeed offers over 150 validated apps covering online ordering, reservations, loyalty, delivery, and more.

	Custom App	Approved Integration
Built for	Your business only	Any Lightspeed merchant
Available in	Not listed — private use	Integration Hub / Marketplace
Developed by	You or your hired developer	Lightspeed technology partner
Supported by	You or your developer	The integration partner
API access	Via Account Manager (paid)	Managed by the partner

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

Custom integrations currently have access to the following endpoints. Refer to the API Reference for full specifications.

Financial API

Provides financial export data at the order, daily, and period level.

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

→ Financial API Documentation.

Items API

Provides item data, including:

• Item names
• Identifiers
• Configuration details
• Pricing and cost information

Used for database synchronization and accounting purposes.

→ Items API 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)

IMPORTANT

The following scopes are not supported for custom integrations: orders-api propertymanagent, and reservations.

API Client Policy

Lightspeed provides one API client per business account.

This API client supports:

• Financial data retrieval
• Item synchronization across locations

Restrictions:

• Credentials cannot be resold, shared, or redistributed
• One client per business account
• No access to the Developer Portal
• Multiple locations connect using the same API client

Development and Testing:

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

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

note

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

Client Credentials and Demo Accounts

By default, the API client credentials provided to custom integration developers are for the production environment. This ensures immediate access to live account data.

If you need to test without affecting live data, you can request an empty test account and a client for the trial environment during the API access process.

Demo Account Notes:

• Demo accounts contain no pre-filled data
• Developers must create menu items, run test orders, and generate sales data manually

warning

A connected iPad is required for demo accounts to function. This applies to all merchants and developers.

Authentication

The K-Series API uses OAuth 2.0 with the Authorization Code Grant flow. See the Authorization Overview and Authentication Tutorial for more details.

Developer Portal

The Developer Portal is reserved for Lightspeed Approved Partners — organizations that manage integrations across multiple Lightspeed merchants, such as online ordering platforms (e.g., Deliverect, Uber Eats), property management systems (e.g., Opera), and accounting providers.

Custom integrators do not have access to the Developer Portal.

To run your application, you only need an API client and a K-Series account. If you need to make changes to your client configuration — such as updating your redirect URI — create a support ticket. Make sure to include your client ID and the details of the change.

note

You do not need Developer Portal access to build or operate a custom integration. All client configuration changes are handled through support.

Documentation

• Product Help
• API Guides
• Quick Start Guide
• API Reference
• Postman Collection

Support During Development

The Technical Partner Support team can assist with:

• API clarification
• Documentation guidance
• Issue investigation (API-side)
• Logging bugs and enhancement requests

warning

Implementation guidance, workflow questions, and troubleshooting related to your specific integration is the responsibility of the integrator. We expect developers to have a working understanding of RESTful APIs and OAuth 2.0 before beginning development.

What's Not Included

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

Opening a Support Ticket

Send an email to kseries.api@lightspeedhq.com with a descriptive subject line. To ensure issues are addressed in a timely and efficient manner, include the following information when opening a ticket.

Required

• businessLocationId (K-Series) or accountId (L-Series)
• API client ID
• Request URL including headers (with access tokens or passwords redacted)
• Timestamps
• Error code or message

If Applicable

• Webhook URL
• Payloads
• JSON responses
• Any other information that could help with troubleshooting

tip

The more context you provide upfront, the faster we can investigate. Tickets missing required information may experience delays.