Lightspeed Products API
The Products API from Lightspeed — 2 operation(s) for products.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/lightspeed-pos-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Lightspeed Retail X-Series Products API
description: 'Partial OpenAPI 3.1 representation of the Lightspeed Retail X-Series
(formerly Vend) REST API. The X-Series API is documented at
https://x-series-api.lightspeedhq.com/ and uses OAuth 2.0 with scope-based
access control. The base URL is per-tenant under the
https://x-series-api.lightspeedhq.com domain. Authentication uses Bearer
access tokens issued via the OAuth 2.0 authorization-code flow.
'
version: 2.0.0
contact:
name: Lightspeed Commerce
url: https://x-series-api.lightspeedhq.com/
servers:
- url: https://{domainPrefix}.retail.lightspeed.app/api/2.0
description: Per-retailer X-Series API host.
variables:
domainPrefix:
default: example
description: Retailer subdomain prefix.
security:
- OAuth2: []
tags:
- name: Products
paths:
/products:
get:
summary: Lightspeed List Products
operationId: listProducts
security:
- OAuth2:
- products.read
parameters:
- name: page_size
in: query
schema:
type: integer
default: 50
responses:
'200':
description: A page of products.
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Product'
examples:
ListProducts200Example:
summary: Default listProducts 200 response
x-microcks-default: true
value:
data:
- id: 3f2504e0-4f89-41d3-9a0c-0305e82c3301
source_id: '500123'
handle: example
sku: SKU-1001
name: Sample name
description: example
price_excluding_tax: 69.88
brand_id: 3f2504e0-4f89-41d3-9a0c-0305e82c3301
active: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Products
post:
summary: Lightspeed Create a Product
operationId: createProduct
security:
- OAuth2:
- products.write
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Product'
examples:
CreateProductRequestExample:
summary: Default createProduct request
x-microcks-default: true
value:
id: 3f2504e0-4f89-41d3-9a0c-0305e82c3301
source_id: '500123'
handle: example
sku: SKU-1001
name: Sample name
description: example
price_excluding_tax: 48.7
brand_id: 3f2504e0-4f89-41d3-9a0c-0305e82c3301
active: false
responses:
'201':
description: Product created.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Products
/products/{id}:
get:
summary: Lightspeed Get a Product by ID
operationId: getProduct
security:
- OAuth2:
- products.read
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: The product.
content:
application/json:
schema:
$ref: '#/components/schemas/Product'
examples:
GetProduct200Example:
summary: Default getProduct 200 response
x-microcks-default: true
value:
id: 3f2504e0-4f89-41d3-9a0c-0305e82c3301
source_id: '500123'
handle: example
sku: SKU-1001
name: Sample name
description: example
price_excluding_tax: 14.96
brand_id: 3f2504e0-4f89-41d3-9a0c-0305e82c3301
active: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Products
put:
summary: Lightspeed Update a Product
operationId: updateProduct
security:
- OAuth2:
- products.write
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Product'
examples:
UpdateProductRequestExample:
summary: Default updateProduct request
x-microcks-default: true
value:
id: 3f2504e0-4f89-41d3-9a0c-0305e82c3301
source_id: '500123'
handle: example
sku: SKU-1001
name: Sample name
description: example
price_excluding_tax: 5.13
brand_id: 3f2504e0-4f89-41d3-9a0c-0305e82c3301
active: false
responses:
'200':
description: Product updated.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Products
components:
schemas:
Product:
type: object
properties:
id:
type: string
format: uuid
source_id:
type: string
handle:
type: string
sku:
type: string
name:
type: string
description:
type: string
price_excluding_tax:
type: number
format: float
brand_id:
type: string
format: uuid
active:
type: boolean
securitySchemes:
OAuth2:
type: oauth2
description: OAuth 2.0 authorization-code flow with scope-based access.
flows:
authorizationCode:
authorizationUrl: https://secure.retail.lightspeed.app/connect
tokenUrl: https://{domainPrefix}.retail.lightspeed.app/api/1.0/token
scopes:
products.read: Read products, brands, and inventory.
products.write: Create or modify products, brands, and inventory.
sales.read: Read sales transactions.
sales.write: Create or modify sales.
customers.read: Read customers.
customers.write: Create or modify customers.