Lightspeed Commerce

Lightspeed Commerce Promotions API

Promotion operations

GitHub OpenAPI
Business capability
Discount & Promotion Management BC-440.30

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

POST /discount Preview the best promotion for a sale · Apply discounts to a sale object #
Ask an LLM
“Which promotion gives the best discount for this basket?”
“Can I test a promo code against a sale without changing anything on the server?”
Tell an agent
Work out the best discount for sale {sale} for customer {customer} at outlet {outlet} on channel {channel}.
Check promo code {code} against sale {sale} at outlet {outlet} for customer {customer} via {channel}.
GET /promotions List promotions by end date · List promotions #
Ask an LLM
“What promotions are set up for my retail store?”
“Can I list only promotions that end after a certain date?”
Tell an agent
List all my promotions.
List promotions ending on or after {from}.
POST /promotions Create a promotion · Create a promotion #
Ask an LLM
“How do I set up a buy-one-get-one or percentage-off deal?”
“Can a promotion require a promo code and target certain customer groups?”
Tell an agent
Create promotion {name} starting {start} with condition {condition} and action {action}, promo codes {use_code}.
Set up promotion {name} from {start} to {end} for outlets {outlets}, condition {condition}, action {action}, promo code use {use_code}.
GET /promotions/search Search promotions by name, outlet or dates · Search promotions #
Ask an LLM
“Which promotions have 'summer' in their name?”
“Can I find promotions running at a specific outlet?”
Tell an agent
Search promotions whose name contains {name}.
Find promotions linked to outlet {outlet} starting after {start}.
GET /promotions/{promotion_id} Get a promotion · Get a promotion by ID #
Ask an LLM
“What are the conditions and discount of one specific promotion?”
“Can I see when a promotion starts and ends?”
Tell an agent
Get promotion {promotion}.
Show the rules of promotion {promotion}.
PUT /promotions/{promotion_id} Update a promotion · Update a promotion #
Ask an LLM
“Can I change the end date of a running promotion?”
“Do I have to send every field when editing a promotion?”
Tell an agent
Update promotion {promotion} with name {name}, start {start}, condition {condition}, action {action}, promo code use {use_code}.
Extend promotion {promotion} to end at {end}, resending all its fields.
GET /promotions/{promotion_id}/products List products a promotion applies to · Get products for a promotion #
Ask an LLM
“Which products are discounted by a promotion and at what price?”
“Can I search a promotion's products by product name?”
Tell an agent
List the products covered by promotion {promotion}.
Find products named {name} in promotion {promotion}.
GET /promotions/{promotion_id}/promocodes List a promotion's promo codes · Get the promo codes for a promotion #
Ask an LLM
“What promo codes belong to a promotion?”
“Can I export the codes customers can enter for a deal?”
Tell an agent
List the promo codes for promotion {promotion}.
Show every code customers can use for promotion {promotion}.

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