Lightspeed Retail POS (X-Series) API Documentation

This is the complete API documentation for connecting to the Lightspeed Retail POS (X-Series) API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Lightspeed Retail POS (X-Series): Manage products, customers, sales, suppliers, and stores. Keep reading to get started.

Quickstart

Before you run your first Lightspeed Retail POS (X-Series) request, you need three things:

A MindCloud account — sign in or create an account at MindCloud.
A MindCloud API Key — create one in API Keys. Keep it on your server.
At least one Lightspeed Retail POS (X-Series) connection — create or choose one in Connections. Note its connectionId.

Every Lightspeed Retail POS (X-Series) action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/lightspeedRetailPOSXSeries/latest/actions/{actionSlug}

You need a MindCloud API Key and a Lightspeed Retail POS (X-Series) connection. Then call an action such as Get Current User:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/lightspeedRetailPOSXSeries/latest/actions/get-current-user" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Lightspeed Retail POS (X-Series) account that should run the action. MindCloud stores and refreshes the Lightspeed Retail POS (X-Series) credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

Connect Lightspeed Retail POS (X-Series)

You'll need a Lightspeed Retail (X-Series) developer application with the exact redirect URI shown below.

Create or open your Lightspeed developer application
Create an application in the Lightspeed Retail (X-Series) developer portal and copy the client ID and client secret. Unapproved applications can still be used for private and test connections.
Add the MindCloud redirect URI
Set the redirect URI exactly to https://api.mindcloud.co/v1/oauth/lightspeedRetailPOSXSeries/callback.
Start the connection in MindCloud and approve the requested scopes
When MindCloud opens the Lightspeed consent screen, sign in as a retailer admin and approve the requested scopes for the store.

Lightspeed Retail POS (X-Series) actions

All 23 published actions for this Lightspeed Retail POS (X-Series) version. Each page documents the endpoint, arguments, and response controls.

More Commerce apps on the Universal API, behind the same REST shape. Or browse all apps.

Quickstart

Authentication

Connect Lightspeed Retail POS (X-Series)

Lightspeed Retail POS (X-Series) actions

Related apps