Lightspeed Commerce

Lightspeed Commerce Order and Pay API

The Order and Pay API from Lightspeed Commerce — 19 operation(s) for order and pay.

GitHub OpenAPI
Business capability
Cart & Checkout AE-140.20

Operations 20

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 /o/op/data/businesses List businesses and locations for my token · Get Businesses #
Ask an LLM
“Which businesses and business locations can my access token reach?”
“How do I find the business location ID I need for ordering calls?”
Tell an agent
List every business and business location my access token is linked to.
Show me the business location IDs available to this integration.
GET /o/op/data/{businessLocationId}/floorplans List a location's floorplans · Get All Floorplans #
Ask an LLM
“What floorplans are set up for my restaurant location?”
“Can I get the floorplans with their tables expanded in one call?”
Tell an agent
List the floorplans for business location {businessLocationId}.
Get all floorplans at location {businessLocationId} with tables expanded set to {expandTables}.
GET /o/op/data/{businessLocationId}/floorplans/{floorPlanId}/tables List the tables on one floorplan · Get Floorplan Tables #
Ask an LLM
“Which tables are on a particular floorplan in my venue?”
“How do I get the table list for just one dining room layout?”
Tell an agent
List the tables on floorplan {floorPlanId} at location {businessLocationId}.
Show the table numbers for floorplan {floorPlanId} in business location {businessLocationId}.
GET /o/op/data/account-profiles List active order profiles for a location · Get All Order Profiles #
Ask an LLM
“What order profiles are active at my business location?”
“Where do I find the order profile codes to use when placing online orders?”
Tell an agent
List all active order profiles for business location {businessLocationId}.
Show me the order profile codes available at location {businessLocationId}.
GET /o/op/data/{businessLocationId}/account-profiles/tagcode/{tagCode} Get one order profile by its code · Get Single Order Profile #
Ask an LLM
“How do I look up the details of a single order profile by its code?”
“Can I check what an order profile code like TAKEAWAY is configured to do?”
Tell an agent
Get the order profile with code {tagCode} at location {businessLocationId}.
Show the settings of order profile {tagCode} for business location {businessLocationId}.
GET /o/op/1/menu/list List the menus at a business location · Get All Menus #
Ask an LLM
“Which menus exist for my business location?”
“How can I find the menu IDs before loading a full menu?”
Tell an agent
List all menus for business location {businessLocationId}.
Show the menu names and IDs at location {businessLocationId}.
GET /o/op/1/menu/load/{menuId} Load a single menu (deprecated V1) · Get Single Menu #
Ask an LLM
“How do I load a menu with the older deprecated V1 menu endpoint?”
“Does the V1 single-menu load still work without product modifier groups?”
Tell an agent
Load menu {menuId} for location {businessLocationId} using the deprecated V1 endpoint.
Fetch V1 menu {menuId} at location {businessLocationId} for order profile {accountProfile}.
GET /o/op/2/menu/load/{menuId} Load a single menu with modifiers (V2) · Get Single Menu V2 #
Ask an LLM
“How do I load a full menu including product modifier groups and modifiers?”
“Can I get a menu's rich content like descriptions and images in the V2 load?”
Tell an agent
Load menu {menuId} for location {businessLocationId} with the V2 endpoint including modifiers.
Get V2 menu {menuId} at location {businessLocationId} with rich content set to {richContent}.
GET /o/op/1/menu/modifiers List production instructions for a location · Get Modifiers #
Ask an LLM
“What production instructions like 'no onions' are set up at my location?”
“Where can I get the list of kitchen modifiers for a business location?”
Tell an agent
List all production instruction modifiers for location {businessLocationId}.
Show the kitchen modifiers configured at business location {businessLocationId}.
GET /o/op/1/menu/discounts List discounts at a business location · Get Discounts #
Ask an LLM
“Which discounts are available at my restaurant location?”
“Can I pull the discount list to show in my ordering app?”
Tell an agent
List the discounts configured for business location {businessLocationId}.
Get every discount I can apply at location {businessLocationId}.
POST /o/op/1/order/local Place a dine-in order · Create Local Order #
Ask an LLM
“How do I send a dine-in order for a table to the POS?”
“Can a dine-in order include the table number and number of guests?”
Tell an agent
Place a dine-in order at location {businessLocationId} for table {tableNumber} with reference {thirdPartyReference}.
Create a dine-in order via endpoint {endpointId} at location {businessLocationId} for {clientCount} guests.
POST /o/op/1/order/toGo Place a takeaway or delivery order · Create To Go Order #
Ask an LLM
“How do I submit a takeaway order from my online ordering site to the POS?”
“Can I send a delivery order with the customer's delivery address?”
Tell an agent
Place a takeaway order at location {businessLocationId} with reference {thirdPartyReference}.
Create a delivery order at location {businessLocationId} to be delivered to {deliveryAddress}.
GET /o/op/1/order/table/getCheck List all open checks for today · Get All Open Checks #
Ask an LLM
“Which orders are still open today at my location?”
“How can I see every unpaid check for the current day?”
Tell an agent
List all open checks today for business location {businessLocationId}.
Show every unpaid order for the current day at location {businessLocationId}.
GET /o/op/1/order/table/{tableNumber}/getCheck Get the open check for a table · Get Open Check by Table #
Ask an LLM
“How do I pull up the open bill for a specific table number?”
“If a table has two orders, which open check comes back?”
Tell an agent
Get the open check for table {tableNumber} at location {businessLocationId}.
Show what table {tableNumber} currently owes at business location {businessLocationId}.
GET /o/op/1/order/accounts/{accountIdentifier} Get a check by its account identifier · Get Single Check #
Ask an LLM
“How do I retrieve a check when I only have its account identifier?”
“Can I look up an order by account identifier instead of by table?”
Tell an agent
Get the check with account identifier {accountIdentifier} at location {businessLocationId}.
Look up check {accountIdentifier} for business location {businessLocationId}.
POST /o/op/1/pay Apply a payment to an existing order · Apply a Payment #
Ask an LLM
“How do I record a payment against an open order from my app?”
“Can I include a tip when applying a payment to a check?”
Tell an agent
Apply a payment of {paymentAmount} to order {iKaccountIdentifier} at location {businessLocationId}.
Pay {paymentAmount} plus a {tipAmount} tip on account {iKaccountId} with reference {thirdPartyPaymentReference}.
POST /o/op/1/printMsg Send a message to the POS screen or printer · Print Message #
Ask an LLM
“Can I push a notification message to the register screen?”
“What happens to a POS message if the register is offline?”
Tell an agent
Send the message {message} to the POS at location {businessLocationId}.
Show {message} on the register at location {businessLocationId} and print it too: {alsoToPrinter}.
GET /o/op/1/itemAvailability Check item availability by SKU · Get Item Availability Information #
Ask an LLM
“Which of my menu items are currently unavailable or 86'd?”
“How do I check availability for a few SKUs in the query string?”
Tell an agent
Check availability of SKUs {skus} at location {businessLocationId}.
Get item availability for {skus} at business location {businessLocationId}, page {page}.
POST /o/op/1/itemAvailability Check availability for a long SKU list · Get Item Availability Information by POST #
Ask an LLM
“How do I check availability for a long list of SKUs sent in the request body?”
“Is there a POST version of the item availability lookup for many items?”
Tell an agent
Post the SKU list {skus} to check item availability at location {businessLocationId}.
Look up availability in bulk for body SKUs {skus} at location {businessLocationId}, {size} per page.
GET /o/op/1/onlineOrderReadiness Check if a location can accept online orders · Get the readiness status for accepting Online Orders #
Ask an LLM
“Is my business location ready to accept online orders right now?”
“How can I tell whether the POS will take incoming online orders?”
Tell an agent
Check online order readiness for business location {businessLocationId}.
Tell me whether location {businessLocationId} can accept online orders.

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://artifacts.apis.io/lightspeed/openapi/lightspeed-order-and-pay-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/lightspeed/json-schema/lightspeed-ape-local-order-item-line-schema.json
📊
JSONSchema
https://artifacts.apis.io/lightspeed/json-schema/lightspeed-ape-account-snapshot-schema.json
📊
JSONSchema
https://artifacts.apis.io/lightspeed/json-schema/lightspeed-ape-standalone-payment-schema.json
📊
JSONSchema
https://artifacts.apis.io/lightspeed/json-schema/lightspeed-ape-customer-info-schema.json
📊
JSONSchema
https://artifacts.apis.io/lightspeed/json-schema/lightspeed-ape-to-go-order-item-line-schema.json
📊
JSONSchema
https://artifacts.apis.io/lightspeed/json-schema/lightspeed-ape-menu-v2-schema.json

Other Resources

🔗
ChangeLog
https://x-series-api.lightspeedhq.com/changelog
🔗
LLMsTxt
https://artifacts.apis.io/lightspeed/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-order-and-pay-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-order-and-pay-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Lightspeed Order and Pay API
  version: 1.0.0
  x-logo:
    altText: Lightspeed Commerce
    url: static/lightspeed@2x.png
  description: 'Operations tagged Order and Pay across 2 of this provider''s published API definitions: lightspeed-k-series-openapi.json, lightspeed-k-series-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.trial.lsk.lightspeed.app
  description: Demo URL
  x-bump-branch-name: demo
- url: https://api.lsk.lightspeed.app
  description: Production URL
  x-bump-branch-name: prod
tags:


# --- truncated at 32 KB (137 KB total) ---
# Full source: https://artifacts.apis.io/lightspeed/openapi/lightspeed-order-and-pay-api-openapi.yml