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

Lightspeed Commerce Order and Pay API

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

Lightspeed Commerce Order and Pay API is one of 58 APIs that Lightspeed Commerce 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, an API reference, a getting-started guide, and a changelog.

This API exposes 20 operations across 19 paths, and defines 51 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

20 operations 19 paths 51 schemas 15 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://{domain_prefix}.retail.lightspeed.app
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Lightspeed Commerce 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 20

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

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

Schemas 51

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

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Lightspeed Commerce publishes across the network.

Lightspeed Retail R-Series API
Lightspeed eCom API
Lightspeed eCom E-Series (Ecwid) API
Lightspeed Restaurant O-Series (Kounta) API
Lightspeed Golf (Chronogolf) Partner API
Lightspeed Commerce Audit API
Lightspeed Commerce Brands API
Lightspeed Commerce Channel Request Log API
Lightspeed Commerce Consignment Products API
Lightspeed Commerce Consignments API
Lightspeed Commerce Customer Addresses API
Lightspeed Commerce Customer Groups API
Where this information came from

This is an independent, third-party profile of Lightspeed Commerce 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.