Lightspeed Commerce

Lightspeed Commerce Products API

Product operations

GitHub OpenAPI
Business capability
Item Master Data Management BC-2370.10

Operations 8

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 /products List products in the catalog · List products #
Ask an LLM
“How do I list all products in my retail catalog?”
“Can I filter the product list by SKU or family name?”
Tell an agent
List my products, {page_size} per page.
List products with SKU {sku}.
POST /products Create a new product · Create product #
Ask an LLM
“How do I add a new product with a price and SKU?”
“Can I create a product with variants and supplier details in one call?”
Tell an agent
Create a product named {name} with SKU {sku} priced at {price_excluding_tax} before tax.
Add new product {name} from supplier {supplier_id} with supply price {supply_price}.
DELETE /products/{product_id} Delete a product or single variant · Delete a single product #
Ask an LLM
“How do I delete one product or just one of its variants?”
“Does deleting a variant ID remove the whole family?”
Tell an agent destructive · confirm first
Delete product {product_id}.
Remove the single variant {product_id} from its family.
GET /products/{product_id} Get a single product · Get a single product #
Ask an LLM
“How do I fetch the full details of one product by ID?”
“What price and SKU does a specific product have?”
Tell an agent
Get product {product_id}.
Show the details of product {product_id}.
PUT /products/{product_id} Update an existing product · Update a product #
Ask an LLM
“How do I change the details of a product I already created?”
“Can I update shared family fields separately from variant details?”
Tell an agent
Update product {product_id} with these details: {details}.
Change the common family fields on product {product_id} to {common}.
POST /products/{product_id}/actions/image_upload Upload an image for a product · Upload an image #
Ask an LLM
“How do I upload a product photo as a file?”
“What encoding does a product image upload need?”
Tell an agent
Upload image {image} to product {product_id}.
Attach a new photo file to product {product_id}.
DELETE /products/{product_id}/all Delete an entire product variant family · Delete a product family #
Ask an LLM
“How do I delete a product along with all of its variants?”
“Can I remove a whole variant family in one call?”
Tell an agent destructive · confirm first
Delete the entire variant family of product {product_id}.
Remove product {product_id} and every variant in its family.
GET /products/{product_id}/price_book_products List price books a product belongs to · Get a list of price books the given product is in #
Ask an LLM
“Which price books include this product?”
“How can I see special pricing entries for one product?”
Tell an agent
List the price books product {product_id} is in.
Show price book entries for product {product_id}.

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-products-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-products-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-products-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 Products 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 (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lightspeed/refs/heads/main/openapi/lightspeed-products-api-openapi.yml