Lightspeed Commerce

Lightspeed Commerce Inventory API

Inventory operations

GitHub OpenAPI
Business capability
Inventory Management BC-530

Operations 10

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 /custom_inventory_adjustment_reasons List custom inventory adjustment reasons · List custom inventory adjustment reasons #
Ask an LLM
“What custom reasons have we set up for adjusting stock?”
“Can I page through our custom stock adjustment reasons?”
Tell an agent
List our custom inventory adjustment reasons.
Show custom stock adjustment reasons, {page_size} per page.
POST /custom_inventory_adjustment_reasons Create a custom inventory adjustment reason · Create a custom inventory adjustment reason #
Ask an LLM
“How do I add a new reason like 'water damage' for stock adjustments?”
“Can I create a custom adjustment reason that starts out disabled?”
Tell an agent
Create a custom adjustment reason named {name} of type {type}, enabled {enabled}.
Add {name} as a new {type} reason for inventory adjustments, with enabled set to {enabled}.
PUT /custom_inventory_adjustment_reasons/{custom_reason_id} Rename or toggle an adjustment reason · Update a custom inventory adjustment reason #
Ask an LLM
“How do I disable a custom stock adjustment reason we no longer use?”
“Can I rename an existing custom adjustment reason?”
Tell an agent
Rename custom adjustment reason {custom_reason_id} to {name}.
Set enabled to {enabled} on custom adjustment reason {custom_reason_id}.
POST /inventory List inventory records across products · List inventory records #
Ask an LLM
“How do I pull inventory records for all products and outlets?”
“Can the inventory record list include deleted records?”
Tell an agent
List inventory records across all products.
Get inventory records for product {product_id}, including deleted ones: {include_deleted}.
POST /inventory/reorder_points Set reorder points for products at outlets · Set reorder points #
Ask an LLM
“How do I set the reorder point for products at specific outlets?”
“Does the reorder method have to match across a product's variants?”
Tell an agent
Set reorder points for these products at their outlets.
Update the reorder thresholds for a product family across outlets.
GET /inventory/{product_id} Get inventory records for one product · List inventory records for a single product #
Ask an LLM
“How much of a specific product do we have at each outlet?”
“Can I include the variants when looking up one product's inventory records?”
Tell an agent
Get the inventory records for product {product_id} at all outlets.
Show inventory records for product {product_id} with variants included: {variants}.
POST /inventory_levels List inventory levels with filters · List inventory levels #
Ask an LLM
“Which products need to be procured based on current inventory levels?”
“Can I filter inventory levels by supplier or outlet location?”
Tell an agent
List inventory levels at locations {location_ids}.
Show inventory levels for supplier {supplier_ids}, only items to be procured: {to_be_procured_only}.
GET /inventory_levels/{product_id} Get inventory levels for one product · List inventory levels for a single product #
Ask an LLM
“What are the current stock levels for a single product?”
“Can I include inactive outlets when checking one product's levels?”
Tell an agent
Get inventory levels for product {product_id}.
Show stock levels for product {product_id} including inactive ones: {include_inactive}.
GET /stock_adjustments List stock adjustments · List stock adjustments #
Ask an LLM
“What stock adjustments have been made recently?”
“How do I page through the history of inventory adjustments?”
Tell an agent
List our stock adjustments.
Show stock adjustments after cursor {after}, {page_size} per page.
POST /stock_adjustments Adjust stock for items in a batch · Create stock adjustments #
Ask an LLM
“How do I adjust stock counts for many items in one request?”
“What's the maximum number of stock adjustments per batch?”
Tell an agent
Create these stock adjustments: {stock_adjustments}.
Record a batch of inventory adjustments {stock_adjustments}.

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