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:

POST https://connect.mindcloud.co/v2/universal/apps/lightspeedRetailPOSXSeries/actions/{actionSlug}/run

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

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/lightspeedRetailPOSXSeries/actions/get-retailer/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

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.

Authenticate with a MindCloud API Key plus a connectionId for your Lightspeed Retail POS (X-Series) account. See Lightspeed Retail POS (X-Series) API Authentication for the full flow and how to get your connection credentials.

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

Lightspeed Retail POS (X-Series) actions

Related apps