Lightspeed Commerce

Lightspeed Commerce Sales API

Sale operations

GitHub OpenAPI
Business capability
Sales Transaction Management BC-2320.10

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /sales List sales · List Sales #
Ask an LLM
“What sales has my store made recently?”
“Can I page backwards through older sales?”
Tell an agent
List my store's sales.
Show {size} sales recorded before sale {before}.
POST /sales Record a new sale · Create a sale #
Ask an LLM
“How do I push an order from my own system into the POS as a sale?”
“Can I create a sale that is saved as a layby or left open rather than closed?”
Tell an agent
Create a sale from source {source} in state {state}.
Record a {state} sale from {source} for customer {customer} with line items {items}.
GET /sales/{sale_id} Get a sale · Get a single sale #
Ask an LLM
“What was sold and paid on a specific sale?”
“Can I retrieve one sale with its line items and payments?”
Tell an agent
Get sale {sale}.
Show the line items and payments of sale {sale}.
PUT /sales/{sale_id} Update an existing sale · Update a sale #
Ask an LLM
“Can I add a payment or change the customer on a sale that's already recorded?”
“How do I change the state of an existing sale, say from saved to closed?”
Tell an agent
Update sale {sale} to state {state} with source {source}.
Attach customer {customer} to sale {sale}, keeping source {source} and state {state}.
POST /sales/{sale_id}/actions/return Start a return for a sale · Return a sale #
Ask an LLM
“How do I process a customer return against a closed sale?”
“What does starting a return create before I add the refund?”
Tell an agent
Start a return for sale {sale}.
Open a return sale against closed sale {sale}.

Documentation

📖
Documentation
https://x-series-api.lightspeedhq.com/docs/introduction
📖
APIReference
https://x-series-api.lightspeedhq.com/reference
📖
GettingStarted
https://x-series-api.lightspeedhq.com/docs/quick_start
📖
Documentation
https://api-portal.lsk.lightspeed.app/
📖
APIReference
https://api-docs.lsk.lightspeed.app/
📖
GettingStarted
https://api-portal.lsk.lightspeed.app/quick-start/intro

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lightspeed/refs/heads/main/openapi/lightspeed-sales-api-openapi.yml

Other Resources

🔗
ChangeLog
https://x-series-api.lightspeedhq.com/changelog
🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/lightspeed/refs/heads/main/llms/lightspeed-llms.txt
🔗
SignUp
https://developers.retail.lightspeed.app/register
🔗
ChangeLog
https://api-docs.lsk.lightspeed.app/changes

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/lightspeed:lightspeed-sales-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

lightspeed-sales-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: x-series.api@lightspeedhq.com
    name: Lightspeed Developer Relations
    url: https://developers.retail.lightspeed.app
  description: Lightspeed Retail (X-Series) API.
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: https://developers.lightspeedhq.com/terms
  title: 2026-07 Sales API
  version: 2026-07
servers:
- url: https://{domain_prefix}.retail.lightspeed.app/api/2026-07
  variables:
    domain_prefix:
      default: example
      description: Domain prefix of the store to be operated on
security:
- bearerAuth: []
tags:


# --- truncated at 32 KB (44 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lightspeed/refs/heads/main/openapi/lightspeed-sales-api-openapi.yml