How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Lightspeed

Lightspeed Order and Pay API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Lightspeed Order and Pay API is one of 27 APIs that Lightspeed publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Order And Pay. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and code examples.

This API exposes 19 operations across 18 paths, and defines 47 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.trial.lsk.lightspeed.app, https://api.lsk.lightspeed.app.

19 operations 18 paths 47 schemas 14 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://x-series-api.lightspeedhq.com/api/2.0
Authentication
OAuth 2.0
Contact
Lightspeed Commerce
Resource Areas
1

Authentication & Security 1

Lightspeed Order and Pay API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 8 scopes.

  • OAuth2 — The Lightspeed Restaurant K-Series APIs support OAuth2 authentication using the [authorization code grant flow](https://www.oauth.com/oauth2-servers/server-sid…

Paths & Operations 19

Across 18 paths, the API surfaces 19 operations — 14 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Order and Pay 19
GET
/o/op/data/businesses
Lightspeed Get Businesses
apeLookupBusinesses → 200
GET
/o/op/data/{businessLocationId}/floorplans
Lightspeed Get All Floorplans
apeLookupFloorPlans 2 params → 200404
GET
/o/op/data/{businessLocationId}/floorplans/{floorPlanId}/tables
Lightspeed Get Floorplan Tables
apeGetTables 2 params → 200
GET
/o/op/data/account-profiles
Lightspeed Get All Order Profiles
apeAccountProfiles 1 param → 200
GET
/o/op/data/{businessLocationId}/account-profiles/tagcode/{tagCode}
Lightspeed Get Single Order Profile
apeGetAccountProfile 2 params → 200
GET
/o/op/1/menu/list
Lightspeed Get All Menus
apeLoadMenus 1 param → 200
GET
/o/op/1/menu/load/{menuId}deprecated
Lightspeed Get Single Menu
apeGetMenuById 4 params → 200503
GET
/o/op/2/menu/load/{menuId}
Lightspeed Get Single Menu V2
apeGetMenuByIdV2 4 params → 200503
GET
/o/op/1/menu/modifiers
Lightspeed Get Modifiers
apeLoadAllModifiers 1 param → 200
GET
/o/op/1/menu/discounts
Lightspeed Get Discounts
apeLoadAllDiscounts 1 param → 200
POST
/o/op/1/order/local
Lightspeed Create Local Order
apeLocalOrder body → 200400409
POST
/o/op/1/order/toGo
Lightspeed Create to Go Order
apePlaceToGoOrder body → 200400409
GET
/o/op/1/order/table/getCheck
Lightspeed Get All Open Checks
apeGetCheck 1 param → 200400
GET
/o/op/1/order/table/{tableNumber}/getCheck
Lightspeed Get Open Check by Table
apeCheckLookup 2 params → 200404
GET
/o/op/1/order/accounts/{accountIdentifier}
Lightspeed Get Single Check
apeCheckLookupWithaccountIdentifier 2 params → 200400404
POST
/o/op/1/pay
Lightspeed Apply a Payment
apeMakePayment body → 200400
POST
/o/op/1/printMsg
Lightspeed Print Message
apePrintMsg 1 param body → 200
GET
/o/op/1/itemAvailability
Lightspeed Get Item Availability Information
apeGetRestrictedItems 4 params → 200400
POST
/o/op/1/itemAvailability
Lightspeed Get Item Availability Information by POST
apeGetRestrictedItemsByPost 3 params body → 200400

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are apeAccountSnapshot (19 properties), apeAccountLineItem (16 properties), apeMenuItemEntryParentV2 (13 properties), apeMenuItemEntryParent (13 properties). Each schema is shown below with its type and property counts.

apeRestrictedItemPaginatedResponse
object
2 properties
apeAccountSnapshot
object
19 properties
apeItemModifier
object
1 property
apeTopLevelMenuGroupEntry
apeMenuItemTax
object
3 properties
apeCurrentInfo
object
2 properties
apeCustomerInfo
object
9 properties 1 required
apeMenuItemEntry
apeMenuV2
object
5 properties
apeLocalOrderItemLine
object
10 properties 2 required
apeAccountProfiles
object
2 properties
apeStandalonePayment
object
Payment to apply to an existing order.
12 properties 4 required
apeItemRichData
object
7 properties
apeTable
object
The tables under this floorplan.
6 properties
apeMenuModifierGroupV2
object
A product modifier group containing product modifiers to select from.
8 properties
apeToGoOrderItemLine
object
9 properties 2 required
apeSkusRequest
object
1 property 1 required
apeTagCode
string
The order profile [code](https://api-docs.lsk.lightspeed.app/operation/operation-apeaccountprofilesoperation-apeaccountprofiles-200-body-application-json-accou…
apeSubItemOrderLine
object
6 properties 2 required
apeItemTexts
object
3 properties
apeMenuGroupEntryV2
apeAccountLineItem
object
16 properties
apeRestrictedItem
object
3 properties
apeMenuItemEntryParentV2
object
13 properties
apeAccountPaymentLine
object
Payments associated with this check.
7 properties
apeMenuDealEntry
apeModifier
object
The modifiers of the item for this sale line
2 properties
apeProductionInstructionEntry
object
Array of production instructions for this group
2 properties
apeMenuDealEntryV2
apeProductionInstruction
object
4 properties
apePaymentSubmissionResponse
object
Acknowledgement that the payment was accepted for delivery to the POS.
1 property
apeOrderPayment
object
3 properties 1 required
apeCurrentWarning
object
2 properties
apeMenuGroupEntry
apeMenuItemEntryV2
apeFloorPlanId
integer
The unique identifier for the floor plan. See [Get Floorplans](https://api-docs.lsk.lightspeed.app/operation/operation-apelookupfloorplans)
apeMenuDealGroup
object
Collections of item groups within the combo to select from.
8 properties
apeDiscount
object
4 properties
apeMenu
object
5 properties
apeAccountProfile
object
4 properties
apeMenuProductModifierEntryV2
apePaymentBadRequestError
object
Standard error payload returned for a rejected payment request.
5 properties
apeBusinessLocationId
integer
The unique identifier for the business location.
apeMenuItemEntryParent
object
13 properties
apeTopLevelMenuGroupEntryV2
apePaginatedMetadata
object
4 properties
apeMenuDealGroupV2
object
Collections of item groups within the combo to select from.
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightspeed-pos-order-and-pay-api-openapi.yml Raw ↑

Other APIs Lightspeed publishes across the network.

Lightspeed eCom C-Series API
AE Profile APIs.io
Lightspeed eCom E-Series API (Ecwid)
AE Profile APIs.io
Lightspeed Restaurant L-Series API
AE Profile APIs.io
Lightspeed Restaurant O-Series API (Kounta)
AE Profile APIs.io
Lightspeed Restaurant G-Series API (Gastrofix)
AE Profile APIs.io
Lightspeed ChronoGolf Partner API
AE Profile APIs.io
Lightspeed Account API
AE Profile APIs.io
Lightspeed Brands API
AE Profile APIs.io
Lightspeed Catalog API
AE Profile APIs.io
Lightspeed Customer API
AE Profile APIs.io
Lightspeed Customers API
AE Profile APIs.io
Lightspeed Financial API
AE Profile APIs.io
#Order And Pay
← Back to L APIs
API Details
ID
lightspeed-pos:lightspeed-pos-order-and-pay-api
Base URL
https://x-series-api.lightspeedhq.com/api/2.0
Docs
https://x-series-api.lightspeedhq.com/
Provider
Lightspeed
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=lightspeed-pos-order-and-pay-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/lightspeed-pos-order-and-pay-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Lightspeed Order and Pay API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.