Developer API

Build apps for retail

The Lightspeed OnSite API opens up the Lightspeed OnSite platform to developers and enterprising retailers, allowing the world's most innovative retail stores to take their Lightspeed OnSite solutions to all-new destinations.

Whether it's a custom loyalty program, a third party eCommerce plugin, integration with a backend ERP system, or a mobile sales dashboard, the Lightspeed OnSite API opens up the world of Lightspeed OnSite to the needs and creative vision of your business. While our developers are hard at work building the core of the Lightspeed OnSite engine and expanding its popular front-end interfaces, we invite customers to build out the custom tools needed to take your stores to the next level.

The Lightspeed OnSite API is based on web services, and leverages the power of Lightspeed Server and offers access to the same framework used by the POS screen and Lightspeed OnSite Mobile. And licensing is non-restrictive. Pay no royalties on apps you build or distribute.

Lightspeed developer exchange

Lightspeed Developer Exchange (LDX) is a membership program that grants access to the developer program and website. It allows you to register your program with Lightspeed, communicate with fellow developers and receive tech help from our development team.

To join the Lightspeed Developer Exchange, please contact Lightspeed Sales.

What Can Be Built?

External Loyalty Program
Integration with Backend ERP
Mobile Sales Dashboard

What Cannot Be Built?

Modify existing Lightspeed screens
Extend existing features within Lightspeed

1. What is the Lightspeed OnSite API?

The Lightspeed OnSite API allows innovative retailers, developers and IT managers to build custom apps and integrations on top of the Lightspeed platform by offering a way to read and write data to and from Lightspeed Server.

2. Can Lightspeed build an app for me?

No, we are not offering custom development services at this time.

3. Does the release of this API mean that Lightspeed will no longer be developed?

No, the Lightspeed OnSite API allows developers to extend the Lightspeed OnSite platform through external apps while we focus on improving the core functionality of Lightspeed Server and its desktop and mobile clients.

4. What is the protocol used by the API to communicate with Lightspeed Server?

The Lightspeed OnSite API uses a REST service which operates over HTTP.

5. What development tools can I use to develop apps?

Any tools that can communicate with a REST service can be used to develop apps, for example: PHP, Python and Objective-C.

6. What platforms can I deploy my apps on?

As long as your app can communicate with the Lightspeed Server using REST, platform is not a barrier.

7. Can I test out the API or build apps with the Lightspeed Demo?

No, a Lightspeed Developer Exchange membership and licensed Lightspeed Server is required for development at this time.

8. When I buy the API can my whole team of developers utilize it at the same time?

Yes, provided they have a licensed Lightspeed Server to test with.

9. Can I use the same API kit to develop several applications?

Yes.

10. Can I modify the user interface or functionality of Lightspeed OnSite?

No, developer apps exist as separate desktop, mobile or web-based apps.

11. Can I add additional fields to the Lightspeed OnSite database?

No, if you need to store additional data, you will need to store it in a separate database or in the cloud.

12. How do I read and write data to and from the Lightspeed Server?

You can read and write data using standard REST conventions for accessing data objects, such as GET, PUT and POST. In the initial version of the API, you can read products, customers, invoices, gift cards, taxes and users and create/modify products, customers and invoices. The scope of the API will be expanded in future releases of Lightspeed Server.

13. Can I use SQL to read or write to or from the Lightspeed OnSite database?

No, you must use REST conventions to read and write data from data objects.

14. Can developers use the API to connect other software systems with Lightspeed?

Yes.

15. Will the API allow other credit card processing partners to be used?

No, this would void Lightspeed's PCI certification.

16. Will the API allow me to integrate additional POS hardware?

No, not at this time.

17. What if a future Lightspeed OnSite update changes how the data is organized to work with my app?

Lightspeed API's REST interface will remain as static as possible across Lightspeed OnSite releases. However, major upgrades may require developers to make some updates to their apps to maintain compatibility.

18. Can customers buy apps directly from me?

Yes, developers will be responsible for distributing and supporting their own apps.

19. How can I showcase the app I have developed?

Developers must market their own apps at this time. Lightspeed is exploring ways to showcase developer apps, please stay tuned for more news on this.

20. Am I charged a royalty when I sell an app to a customer?

No.

21. Will my app use up a user license when it connects to Lightspeed Server?

Apps that are registered as read-only on Lightspeed Developer Exchange do not use up a user license when they connect to Lightspeed Server. Apps registered as read-write will use up a user license while connected to the Lightspeed Server

22. Will there be a Lightspeed App Store?

This is being considered. Please stay tuned to lightspeedretail.com for further news.

23. What is Lightspeed Developer Exchange (LDX)?

Lightspeed Developer Exchange is a developer program sold as an annual membership that allows developers to register apps and license customers for their apps. It includes access to API technical documentation, developer forums where developers can go to receive support for their apps, and a feedback section where developers can suggest new features.

24. How do I join LDX and what does it cost?

Membership costs $499 USD annually and can be purchased from Lightspeed Sales or your local Lightspeed reseller.

25. Do I need to register my app on the LDX in order to sell my app or use it internally?

Yes. Registering an app enables you to license Lightspeed OnSite customers to use your app. They provide a portion of their Lightspeed Server license key and you authorize use of your app using Lightspeed Developer Exchange. This allows your app to connect to their Lightspeed Server once you provide them with the app.

26. Can I sell my app if my LDX membership expires?

No, you cannot license new customers to use your app without an active membership.

27. Will my customers be able to use my app if my LDX membership expires?

Yes, they can continue to use your app if your membership lapses.

28. Is there technical documentation my developer can reference?

Yes, technical documentation is available on Lightspeed Developer Exchange.

29. How do i access developer support?

Lightspeed Developer Exchange offers community based forums where members can go to get help.

30. As a developer, can I get access to the API without joining LDX?

No, developers must be a Lightspeed Developer Exchange member to register and license apps that use the API. Customers of your apps do not need to be members, but must own a licensed Lightspeed Server.

31. As a developer, if I sign up for LDX, will I get advance access to Lightspeed OnSite updates/upgrades to test the apps that I have developed?

Yes, we will offer Lightspeed OnSite betas to developers whenever possible.