Introduction to the Lightspeed Retail (X-Series) API

Introduction to the Lightspeed Retail (X-Series) API

Lightspeed Retail (X-Series)'s API can be used to extend Lightspeed Retail (X-Series)'s functionality, and to integrate with other software in the retail ecosystem.
Please use this document as a starting point for exploring the API.

We recommend following the Quick Start tutorial to get up and running.

What is an API?

An API can be thought of as a defined way for different software systems to interact. In the case of Lightspeed Retail (X-Series)'s API, one of those pieces of software is Lightspeed Retail (X-Series) itself.

Lightspeed Retail (X-Series)'s API provides a secured means for other software systems to work with Lightspeed Retail (X-Series) items such as sales and products, on behalf of a Lightspeed Retail (X-Series) retailer account. At Lightspeed Retail (X-Series) we take retailer data security very seriously, so these features are only accessible with retailers' consent.

Lightspeed Retail (X-Series) also offers some 'browser integration' APIs - see below.

Two ways to access to the Lightspeed Retail (X-Series) API

There are two ways to work with Lightspeed Retail (X-Series)'s API - Personal Tokens and Add-ons.

  • Personal Tokens are for use by individual retailers, to connect to their Lightspeed Retail (X-Series) account.
  • Add-ons are registered independently by Developers, and can be connected to multiple retailers.

Authorization works differently for these two types of API access. Please use the Quick Start tutorial to explore these options, and head over to Authorization for a detailed guide.

Using the Lightspeed Retail (X-Series) API

The Lightspeed Retail (X-Series) API is a web API using JSON over HTTP, using secure sockets and token-based authentication. These guides deal with some common concerns and recommendations for API usage:

Communication

There are a few ways for developers to keep in touch with Lightspeed Retail (X-Series):

  • Register to receive the developer newsletter, and create Lightspeed Retail (X-Series) addons.
  • [Email API support]([email protected] Retail (X-Series)hq.com) - if you have any further questions that you can't find the answer to, please get in touch with us.

The API Specifications

The API specifications should be used as a reference for the Lightspeed Retail (X-Series) API contract, describing precisely how to interact with the Lightspeed Retail (X-Series) API.

Lightspeed Retail (X-Series)'s API currently has 2 major versions - v0.9 and v2.0.

API Version 2.0

Version 2.0 is being actively developed. Where possible, we advise you use v2.0.

The v2.0 initiative was designed with specific improvements in mind:

  • Performance: The v2 APIs are generally lighter than v0, returning less auxiliary data than their v0 counterparts. For many of these endpoints, the performance is improved and more resilient to high load on the system.
  • Versioning: The v2 APIs use an auto-incrementing object version number. This allows for more precise pagination and for synchronisation to external systems. Before v2, you would need to rely on timestamps, which are not necessarily a unique value.

Version 0.9

Version 0.9 is the original version of Lightspeed Retail (X-Series)'s API. Several of these endpoints are marked as deprecated.

However, at this stage some endpoints are only available on v0.9 - for example, the creation of sales.

Subject Matter Guides

We have a number of guides on using the API to work with specific Lightspeed Retail (X-Series) features.

Selling and Payments

Inventory and Products

Webhooks

Browser Integration APIs

Besides the main HTTP + JSON API, there are 3 other ways to interact with Lightspeed Retail (X-Series):

  • The Payments API provides a way to integrate payment providers into the Lightspeed Retail (X-Series) Sell Screen.
  • The Redirect API allows you to redirect someone from your app into a Lightspeed Retail (X-Series) Sell Screen
  • The Client API provides some javascript functions for browser extensions to interact with sales.

Did this page help you?