Lightspeed website screenshot

Lightspeed

Lightspeed (Lightspeed Commerce) operates a portfolio of Retail, Restaurant, eCom, and Golf POS platforms via series-named product lines: X-Series (Vend), R-Series (Retail Pro/Cloud), C-Series (eCom), E-Series (Ecwid), K-Series (Restaurant Lightspeed), L-Series, O-Series (Kounta), G-Series (Gastrofix), and the ChronoGolf Partner API.

Lightspeed publishes 21 APIs on the APIs.io network, including Account API, Brands API, Catalog API, and 18 more. Tagged areas include POS, Retail, Restaurant, and Ecommerce.

The Lightspeed catalog on APIs.io includes 3 JSON-LD contexts and 2 Spectral governance rulesets.

Lightspeed’s developer surface includes authentication, engineering blog, and 3 more developer resources.

39.3/100 thin ▼ -6.7 Agent 44/100 agent ready Full breakdown ↓
scored 2026-07-28 · rubric v0.6
AccessEnterpriseSelf serve
27 APIs
POSRetailRestaurantEcommerce

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6
Composite quality — 39.3/100 · thin
Contract Quality 14.3 / 25
Developer Ergonomics 2.6 / 20
Commercial Clarity 5.8 / 20
Operational Transparency 4.1 / 13
Governance 7.0 / 12
Discoverability 5.6 / 10
Agent readiness — 44/100 · agent ready
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 0 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 8 / 8
Request/Response Examples 7 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 0 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/lightspeed-pos: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 27

Individual APIs this provider publishes, each with its own machine-readable definition.

Lightspeed eCom C-Series API

REST API for the Lightspeed eCom C-Series storefront platform.

Lightspeed eCom E-Series API (Ecwid)

REST API for Ecwid-powered Lightspeed eCom E-Series stores.

Lightspeed Restaurant L-Series API

REST API for the Lightspeed Restaurant L-Series cloud POS.

Lightspeed Restaurant O-Series API (Kounta)

REST API for Lightspeed Restaurant O-Series (Kounta).

Lightspeed Restaurant G-Series API (Gastrofix)

REST API for Lightspeed Restaurant G-Series (Gastrofix).

Lightspeed ChronoGolf Partner API

Partner API for ChronoGolf, Lightspeed's tee-time and course management platform.

Lightspeed Account API

The Lightspeed Retail account associated with the access token.

Lightspeed Brands API

The Brands API from Lightspeed — 2 operation(s) for brands.

Lightspeed Catalog API

Categories, manufacturers, and vendors that classify items.

Lightspeed Customer API

Customer records and contact details.

Lightspeed Customers API

The Customers API from Lightspeed — 2 operation(s) for customers.

Lightspeed Financial API

V1 endpoints (`/f/finance/...`) for retrieving sales and financial data. For the newer V2 versions of these endpoints see FinancialV2 ### V1 behaviour - **Sorting**: No guarante...

Lightspeed FinancialV2 API

V2 endpoints (`/f/v2/...`) for retrieving sales and financial data. ### Endpoint Mapping | V1 Endpoint | V2 Endpoint | |-------------|-------------| | `getFinancials` (`/f/finan...

Lightspeed Gift Cards API

The Gift Cards API from Lightspeed — 1 operation(s) for gift cards.

Lightspeed ID Cards API

The ID Cards API from Lightspeed — 2 operation(s) for id cards.

Lightspeed Item API

Inventory items sold and tracked in Lightspeed Retail.

Lightspeed Items API

The Items API from Lightspeed — 2 operation(s) for items.

Lightspeed Order and Pay API

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

Lightspeed Order and Pay: Webhook API

The Order and Pay: Webhook API from Lightspeed — 4 operation(s) for order and pay: webhook.

Lightspeed PMS API

The PMS API from Lightspeed — 3 operation(s) for pms.

Lightspeed Products API

The Products API from Lightspeed — 2 operation(s) for products.

Lightspeed Reservations for Platforms API

The Reservations for Platforms API from Lightspeed — 11 operation(s) for reservations for platforms.

Lightspeed Rich Item API

The Rich Item API from Lightspeed — 6 operation(s) for rich item.

Lightspeed Sale API

Point-of-sale transactions and their line items.

Lightspeed Sales API

The Sales API from Lightspeed — 2 operation(s) for sales.

Lightspeed Staff API

Staff API. Authorisation Code grant type is required for this API with permission ROLE_CONFIG_USERS.

Lightspeed Tax Breakdown API

The Tax Breakdown API from Lightspeed — 1 operation(s) for tax breakdown.

Scroll for all 27

Open Collections 3

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

Pricing Plans 1

Published pricing tiers and plan structures.

Rate Limits 1

Documented rate limits and quota policies.

Lightspeed Pos Rate Limits

4 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Semantic Vocabularies 3

JSON-LD contexts and semantic vocabularies used across these APIs.

Lightspeed Pos Restaurant K Series Context

69 classes · 346 properties

JSON-LD

Lightspeed Pos Retail R Series Context

10 classes · 53 properties

JSON-LD

Lightspeed Pos Retail X Series Context

4 classes · 23 properties

JSON-LD

Spectral Rules 2

Spectral governance rulesets for linting and validating these APIs.

Lightspeed API Rules

5 rules · 3 warnings 2 info

SPECTRAL

Lightspeed API Rules

33 rules · 6 errors 14 warnings 13 info

SPECTRAL

JSON Schema 94

Standalone JSON Schema definitions for this provider's data models.

apeAccountProfile

4 properties

JSON SCHEMA

apeAccountProfiles

2 properties

JSON SCHEMA

apeAccountSnapshot

19 properties

JSON SCHEMA

apeBusinessLocationId

0 properties

JSON SCHEMA

apeCustomerInfo

9 properties

JSON SCHEMA

apeDiscount

4 properties

JSON SCHEMA

apeLocalOrderItemLine

10 properties

JSON SCHEMA

apeMenu

5 properties

JSON SCHEMA

apeMenuV2

5 properties

JSON SCHEMA

apeOrderPayment

3 properties

JSON SCHEMA

apePaymentBadRequestError

5 properties

JSON SCHEMA

apePaymentSubmissionResponse

1 properties

JSON SCHEMA

apeProductionInstruction

4 properties

JSON SCHEMA

apeRestrictedItemPaginatedResponse

2 properties

JSON SCHEMA

apeSkusRequest

1 properties

JSON SCHEMA

apeStandalonePayment

12 properties

JSON SCHEMA

apeTable

6 properties

JSON SCHEMA

apeToGoOrderItemLine

9 properties

JSON SCHEMA

apeWebhookEndpointBusinessLocationDto

4 properties

JSON SCHEMA

apeWebhookEndpoint

9 properties

JSON SCHEMA

financial-apiAbortedOrderDto

4 properties

JSON SCHEMA

financial-apiFinancialDto

6 properties

JSON SCHEMA

financial-apiLSPaymentsDto

4 properties

JSON SCHEMA

financial-apiResourcesTaxRate

2 properties

JSON SCHEMA

financial-apiSaleDto

22 properties

JSON SCHEMA

financial-apiSalesDailyExportDto

3 properties

JSON SCHEMA

financial-apiSalesExportDto

2 properties

JSON SCHEMA

id-cards-apiCreateIdCardBatchRequest

1 properties

JSON SCHEMA

id-cards-apiCreateIdCardsRequest

1 properties

JSON SCHEMA

id-cards-apiCreateIdCardsResponse

2 properties

JSON SCHEMA

id-cards-apiIdCardBatch

3 properties

JSON SCHEMA

items-apiCreateItemDTO

11 properties

JSON SCHEMA

items-apiItemDTO

19 properties

JSON SCHEMA

items-apiUpdateItemDTO

11 properties

JSON SCHEMA

pms-apiBusinessLocationId

0 properties

JSON SCHEMA

pms-apiGetProvider

6 properties

JSON SCHEMA

pms-apiProviderApiKey

0 properties

JSON SCHEMA

pms-apiProviderEndpoint

0 properties

JSON SCHEMA

pms-apiProviderFeatures

0 properties

JSON SCHEMA

pms-apiProviderName

0 properties

JSON SCHEMA

pms-apiRevenueCenterId

0 properties

JSON SCHEMA

pms-apiRevenueCenterName

0 properties

JSON SCHEMA

reservation-servicePlatformProfile

15 properties

JSON SCHEMA

reservation-servicePlatformReservation

13 properties

JSON SCHEMA

staff-apiBOStaff

13 properties

JSON SCHEMA

staff-apiBusinessLocationIds

1 properties

JSON SCHEMA

staff-apiCreatePosStaffDto

9 properties

JSON SCHEMA

staff-apiCreateWebhookRequest

3 properties

JSON SCHEMA

staff-apiPOSStaff

14 properties

JSON SCHEMA

staff-apiReportAccessLevel

2 properties

JSON SCHEMA

staff-apiResponseSchema

3 properties

JSON SCHEMA

staff-apiShift

8 properties

JSON SCHEMA

staff-apiStaffGroup

4 properties

JSON SCHEMA

staff-apiStaff

15 properties

JSON SCHEMA

staff-apiUpdatePosStaffDto

9 properties

JSON SCHEMA

staff-apiUserPermission

2 properties

JSON SCHEMA

staff-apiWebhookDto

7 properties

JSON SCHEMA

teckelLinkSelfPage

1 properties

JSON SCHEMA

teckelLinkSelf

1 properties

JSON SCHEMA

teckelLocalesDto

0 properties

JSON SCHEMA

teckelPictureSpecDto

4 properties

JSON SCHEMA

teckelRichItemDescriptionDto

3 properties

JSON SCHEMA

teckelRichItemDtoDates

2 properties

JSON SCHEMA

teckelRichItemDtoLinks

1 properties

JSON SCHEMA

teckelRichItemDtoPictures

3 properties

JSON SCHEMA

teckelRichItemDto

4 properties

JSON SCHEMA

Account

3 properties

JSON SCHEMA

Attributes

3 properties

JSON SCHEMA

Category

4 properties

JSON SCHEMA

Contact

5 properties

JSON SCHEMA

Customer

8 properties

JSON SCHEMA

Employee

5 properties

JSON SCHEMA

Item

13 properties

JSON SCHEMA

Manufacturer

2 properties

JSON SCHEMA

SaleLine

7 properties

JSON SCHEMA

Sale

12 properties

JSON SCHEMA

Shop

4 properties

JSON SCHEMA

Vendor

4 properties

JSON SCHEMA

Brand

4 properties

JSON SCHEMA

Customer

6 properties

JSON SCHEMA

Product

9 properties

JSON SCHEMA

Sale

9 properties

JSON SCHEMA

Scroll for all 94

JSON Structure 94

JSON Structure definitions describing this provider's data shapes.

Restaurant K Series Ape Discount Structure

4 properties

JSON STRUCTURE

Restaurant K Series Ape Menu Structure

5 properties

JSON STRUCTURE

Restaurant K Series Ape Menu V2 Structure

5 properties

JSON STRUCTURE

Restaurant K Series Ape Table Structure

6 properties

JSON STRUCTURE

Retail R Series Account Structure

3 properties

JSON STRUCTURE

Retail R Series Attributes Structure

3 properties

JSON STRUCTURE

Retail R Series Category Structure

4 properties

JSON STRUCTURE

Retail R Series Contact Structure

5 properties

JSON STRUCTURE

Retail R Series Customer Structure

8 properties

JSON STRUCTURE

Retail R Series Employee Structure

5 properties

JSON STRUCTURE

Retail R Series Item Structure

13 properties

JSON STRUCTURE

Retail R Series Manufacturer Structure

2 properties

JSON STRUCTURE

Retail R Series Sale Line Structure

7 properties

JSON STRUCTURE

Retail R Series Sale Structure

12 properties

JSON STRUCTURE

Retail R Series Shop Structure

4 properties

JSON STRUCTURE

Retail R Series Vendor Structure

4 properties

JSON STRUCTURE

Retail X Series Brand Structure

4 properties

JSON STRUCTURE

Retail X Series Customer Structure

6 properties

JSON STRUCTURE

Retail X Series Product Structure

9 properties

JSON STRUCTURE

Retail X Series Sale Structure

9 properties

JSON STRUCTURE

Scroll for all 94

Examples 85

Example request and response payloads for these APIs.

Scroll for all 85

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Lightspeed Pos Authentication

oauth2 · 1 scheme

SECURITY

Lightspeed Pos Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Scopes 1

OAuth scopes governing access to this provider's APIs.

Lightspeed Pos Scopes

24 scopes · authorizationCode

24 scopes

SCOPES

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Lightspeed Pos Agentic Access

124 operations · 53 acting

124 operations · 53 acting

AGENTIC

Resources

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

Access & Security 3

Authentication, authorization, and security posture

Company 1

The organization behind the API

Source (apis.yml)

apis.yml Raw ↑
aid: lightspeed-pos
url: https://raw.githubusercontent.com/api-evangelist/lightspeed-pos/refs/heads/main/apis.yml
name: Lightspeed
kind: company
description: 'Lightspeed (Lightspeed Commerce) operates a portfolio of Retail, Restaurant, eCom, and Golf POS platforms via
  series-named product lines: X-Series (Vend), R-Series (Retail Pro/Cloud), C-Series (eCom), E-Series (Ecwid), K-Series (Restaurant
  Lightspeed), L-Series, O-Series (Kounta), G-Series (Gastrofix), and the ChronoGolf Partner API.'
accessModel:
  pricing: enterprise
  onboarding: self-serve
  trial: false
  try_now: false
  public: false
  label: Enterprise · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/lightspeed-pos.png
tags:
- POS
- Retail
- Restaurant
- Ecommerce
created: '2026-05-08'
modified: '2026-06-02'
specificationVersion: '0.19'
apis:
- aid: lightspeed:ecom-c-series
  name: Lightspeed eCom C-Series API
  description: REST API for the Lightspeed eCom C-Series storefront platform.
  humanURL: https://developers.lightspeedhq.com/ecom/introduction/introduction/
  tags:
  - REST
  - Ecommerce
  properties:
  - type: Documentation
    url: https://developers.lightspeedhq.com/ecom/introduction/introduction/
- aid: lightspeed:ecom-e-series
  name: Lightspeed eCom E-Series API (Ecwid)
  description: REST API for Ecwid-powered Lightspeed eCom E-Series stores.
  humanURL: https://api-docs.ecwid.com/
  tags:
  - REST
  - Ecommerce
  - Ecwid
  properties:
  - type: Documentation
    url: https://api-docs.ecwid.com/
- aid: lightspeed:restaurant-l-series
  name: Lightspeed Restaurant L-Series API
  description: REST API for the Lightspeed Restaurant L-Series cloud POS.
  humanURL: https://developers.lightspeedhq.com/
  tags:
  - REST
  - Restaurant
  properties:
  - type: Documentation
    url: https://developers.lightspeedhq.com/
- aid: lightspeed:restaurant-o-series
  name: Lightspeed Restaurant O-Series API (Kounta)
  description: REST API for Lightspeed Restaurant O-Series (Kounta).
  humanURL: https://developers.kounta.com/
  tags:
  - REST
  - Restaurant
  - Kounta
  properties:
  - type: Documentation
    url: https://developers.kounta.com/
- aid: lightspeed:restaurant-g-series
  name: Lightspeed Restaurant G-Series API (Gastrofix)
  description: REST API for Lightspeed Restaurant G-Series (Gastrofix).
  humanURL: https://developers.lightspeedhq.com/
  tags:
  - REST
  - Restaurant
  - Gastrofix
  properties:
  - type: Documentation
    url: https://developers.lightspeedhq.com/
- aid: lightspeed:chronogolf-partner
  name: Lightspeed ChronoGolf Partner API
  description: Partner API for ChronoGolf, Lightspeed's tee-time and course management platform.
  humanURL: https://developers.lightspeedhq.com/
  tags:
  - REST
  - Golf
  - Partner
  properties:
  - type: Documentation
    url: https://developers.lightspeedhq.com/
- aid: lightspeed-pos:lightspeed-pos-account-api
  name: Lightspeed Account API
  description: The Lightspeed Retail account associated with the access token.
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://x-series-api.lightspeedhq.com/api/2.0
  tags:
  - Account
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-pos-account-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/
  - type: Documentation
    url: https://developers.lightspeedhq.com/retail/introduction/introduction/
  - type: CodeExamples
    url: https://www.postman.com/lightspeedhq/r-series-api/documentation/01jc01h/r-series-collection
  - type: Documentation
    url: https://api-docs.lsk.lightspeed.app/
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
- aid: lightspeed-pos:lightspeed-pos-brands-api
  name: Lightspeed Brands API
  description: The Brands API from Lightspeed — 2 operation(s) for brands.
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://x-series-api.lightspeedhq.com/api/2.0
  tags:
  - Brands
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-pos-brands-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/
  - type: Documentation
    url: https://developers.lightspeedhq.com/retail/introduction/introduction/
  - type: CodeExamples
    url: https://www.postman.com/lightspeedhq/r-series-api/documentation/01jc01h/r-series-collection
  - type: Documentation
    url: https://api-docs.lsk.lightspeed.app/
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
- aid: lightspeed-pos:lightspeed-pos-catalog-api
  name: Lightspeed Catalog API
  description: Categories, manufacturers, and vendors that classify items.
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://x-series-api.lightspeedhq.com/api/2.0
  tags:
  - Catalog
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-pos-catalog-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/
  - type: Documentation
    url: https://developers.lightspeedhq.com/retail/introduction/introduction/
  - type: CodeExamples
    url: https://www.postman.com/lightspeedhq/r-series-api/documentation/01jc01h/r-series-collection
  - type: Documentation
    url: https://api-docs.lsk.lightspeed.app/
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
- aid: lightspeed-pos:lightspeed-pos-customer-api
  name: Lightspeed Customer API
  description: Customer records and contact details.
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://x-series-api.lightspeedhq.com/api/2.0
  tags:
  - Customer
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-pos-customer-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/
  - type: Documentation
    url: https://developers.lightspeedhq.com/retail/introduction/introduction/
  - type: CodeExamples
    url: https://www.postman.com/lightspeedhq/r-series-api/documentation/01jc01h/r-series-collection
  - type: Documentation
    url: https://api-docs.lsk.lightspeed.app/
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
- aid: lightspeed-pos:lightspeed-pos-customers-api
  name: Lightspeed Customers API
  description: The Customers API from Lightspeed — 2 operation(s) for customers.
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://x-series-api.lightspeedhq.com/api/2.0
  tags:
  - Customers
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-pos-customers-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/
  - type: Documentation
    url: https://developers.lightspeedhq.com/retail/introduction/introduction/
  - type: CodeExamples
    url: https://www.postman.com/lightspeedhq/r-series-api/documentation/01jc01h/r-series-collection
  - type: Documentation
    url: https://api-docs.lsk.lightspeed.app/
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
- aid: lightspeed-pos:lightspeed-pos-financial-api
  name: Lightspeed Financial API
  description: 'V1 endpoints (`/f/finance/...`) for retrieving sales and financial data.


    For the newer V2 versions of these endpoints see FinancialV2


    ### V1 behaviour


    - **Sorting**: No guaranteed sorting order; internal transformations may alter order unpredictably

    - **Transitory Accounts / Unsettled Sales**: Returns closed transactions only

    - **Pagination**: `pageSize` max of 1000. Uses HATEOAS `_links` with `self` and `nextPage` URLs

    - **Daily endpoints** (`getDailyFinancials`): No pagination, no hard cap on results. May have slower response times for
    larger data sets

    - **Backoffice transactions**: Historical dating supported. Transactions will be dated to a past date if the action impacts
    past reports. Can query transactions by original business date

    - **Backoffice modifications** (payment method change and canceling): Modifications appear on the original transaction
    date'
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://x-series-api.lightspeedhq.com/api/2.0
  tags:
  - Financial
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-pos-financial-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/
  - type: Documentation
    url: https://developers.lightspeedhq.com/retail/introduction/introduction/
  - type: CodeExamples
    url: https://www.postman.com/lightspeedhq/r-series-api/documentation/01jc01h/r-series-collection
  - type: Documentation
    url: https://api-docs.lsk.lightspeed.app/
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
- aid: lightspeed-pos:lightspeed-pos-financialv2-api
  name: Lightspeed FinancialV2 API
  description: 'V2 endpoints (`/f/v2/...`) for retrieving sales and financial data.


    ### Endpoint Mapping


    | V1 Endpoint | V2 Endpoint |

    |-------------|-------------|

    | `getFinancials` (`/f/finance/{id}/financials/{from}/{to}`) | `getSales` (`/f/v2/business-location/{id}/sales`) |

    | `getDailyFinancials` (`/f/finance/{id}/dailyFinancials`) | `getBusinessDaySales` (`/f/v2/business-location/{id}/sales-daily`)
    |


    Response DTOs are nearly identical to V1 with the exceptions noted below


    ### V2 behaviour


    - **Sorting**: Explicitly sorted by `timeClosed`

    - **Transitory Accounts /  Unsettled Sales**: Returns closed transactions and ensures no transitory (unclosed) transactions
    are included in reporting

    - **Pagination**: `pageSize` max of 100. No HATEOAS `_links`; uses `nextPageToken` string for pagination instead

    - **Daily endpoints** (`getBusinessDaySales`): No pagination, no hard cap on results. May have slower response times for
    larger data sets

    - **Backoffice transactions**: Historical dating not currently supported — transactions appear as if created at current
    time. Transactions can only be found by the date/time they were actually created. *Historical dating support is planned
    for a future release.*

    - **Backoffice modifications** (payment method change and canceling): Modifications appear on the date the modification
    was performed, not the original transaction date


    If you need to query transactions by their original business date (e.g. for historical reporting or reconciliation); The
    V1 endpoints may be more suitable until backwards compatibility is added to V2 for this aspect.'
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://x-series-api.lightspeedhq.com/api/2.0
  tags:
  - FinancialV2
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-pos-financialv2-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/
  - type: Documentation
    url: https://developers.lightspeedhq.com/retail/introduction/introduction/
  - type: CodeExamples
    url: https://www.postman.com/lightspeedhq/r-series-api/documentation/01jc01h/r-series-collection
  - type: Documentation
    url: https://api-docs.lsk.lightspeed.app/
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
- aid: lightspeed-pos:lightspeed-pos-gift-cards-api
  name: Lightspeed Gift Cards API
  description: The Gift Cards API from Lightspeed — 1 operation(s) for gift cards.
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://x-series-api.lightspeedhq.com/api/2.0
  tags:
  - Gift Cards
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-pos-gift-cards-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/
  - type: Documentation
    url: https://developers.lightspeedhq.com/retail/introduction/introduction/
  - type: CodeExamples
    url: https://www.postman.com/lightspeedhq/r-series-api/documentation/01jc01h/r-series-collection
  - type: Documentation
    url: https://api-docs.lsk.lightspeed.app/
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
- aid: lightspeed-pos:lightspeed-pos-id-cards-api
  name: Lightspeed ID Cards API
  description: The ID Cards API from Lightspeed — 2 operation(s) for id cards.
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://x-series-api.lightspeedhq.com/api/2.0
  tags:
  - ID Cards
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-pos-id-cards-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/
  - type: Documentation
    url: https://developers.lightspeedhq.com/retail/introduction/introduction/
  - type: CodeExamples
    url: https://www.postman.com/lightspeedhq/r-series-api/documentation/01jc01h/r-series-collection
  - type: Documentation
    url: https://api-docs.lsk.lightspeed.app/
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
- aid: lightspeed-pos:lightspeed-pos-item-api
  name: Lightspeed Item API
  description: Inventory items sold and tracked in Lightspeed Retail.
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://x-series-api.lightspeedhq.com/api/2.0
  tags:
  - Item
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-pos-item-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/
  - type: Documentation
    url: https://developers.lightspeedhq.com/retail/introduction/introduction/
  - type: CodeExamples
    url: https://www.postman.com/lightspeedhq/r-series-api/documentation/01jc01h/r-series-collection
  - type: Documentation
    url: https://api-docs.lsk.lightspeed.app/
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
- aid: lightspeed-pos:lightspeed-pos-items-api
  name: Lightspeed Items API
  description: The Items API from Lightspeed — 2 operation(s) for items.
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://x-series-api.lightspeedhq.com/api/2.0
  tags:
  - Items
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-pos-items-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/
  - type: Documentation
    url: https://developers.lightspeedhq.com/retail/introduction/introduction/
  - type: CodeExamples
    url: https://www.postman.com/lightspeedhq/r-series-api/documentation/01jc01h/r-series-collection
  - type: Documentation
    url: https://api-docs.lsk.lightspeed.app/
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
- aid: lightspeed-pos:lightspeed-pos-order-and-pay-api
  name: Lightspeed Order and Pay API
  description: The Order and Pay API from Lightspeed — 18 operation(s) for order and pay.
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://x-series-api.lightspeedhq.com/api/2.0
  tags:
  - Order and Pay
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-pos-order-and-pay-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/
  - type: Documentation
    url: https://developers.lightspeedhq.com/retail/introduction/introduction/
  - type: CodeExamples
    url: https://www.postman.com/lightspeedhq/r-series-api/documentation/01jc01h/r-series-collection
  - type: Documentation
    url: https://api-docs.lsk.lightspeed.app/
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
- aid: lightspeed-pos:lightspeed-pos-order-and-pay-webhook-api
  name: 'Lightspeed Order and Pay: Webhook API'
  description: 'The Order and Pay: Webhook API from Lightspeed — 4 operation(s) for order and pay: webhook.'
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://x-series-api.lightspeedhq.com/api/2.0
  tags:
  - 'Order and Pay: Webhook'
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-pos-order-and-pay-webhook-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/
  - type: Documentation
    url: https://developers.lightspeedhq.com/retail/introduction/introduction/
  - type: CodeExamples
    url: https://www.postman.com/lightspeedhq/r-series-api/documentation/01jc01h/r-series-collection
  - type: Documentation
    url: https://api-docs.lsk.lightspeed.app/
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
- aid: lightspeed-pos:lightspeed-pos-pms-api
  name: Lightspeed PMS API
  description: The PMS API from Lightspeed — 3 operation(s) for pms.
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://x-series-api.lightspeedhq.com/api/2.0
  tags:
  - PMS
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-pos-pms-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/
  - type: Documentation
    url: https://developers.lightspeedhq.com/retail/introduction/introduction/
  - type: CodeExamples
    url: https://www.postman.com/lightspeedhq/r-series-api/documentation/01jc01h/r-series-collection
  - type: Documentation
    url: https://api-docs.lsk.lightspeed.app/
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
- aid: lightspeed-pos:lightspeed-pos-products-api
  name: Lightspeed Products API
  description: The Products API from Lightspeed — 2 operation(s) for products.
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://x-series-api.lightspeedhq.com/api/2.0
  tags:
  - Products
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-pos-products-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/
  - type: Documentation
    url: https://developers.lightspeedhq.com/retail/introduction/introduction/
  - type: CodeExamples
    url: https://www.postman.com/lightspeedhq/r-series-api/documentation/01jc01h/r-series-collection
  - type: Documentation
    url: https://api-docs.lsk.lightspeed.app/
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
- aid: lightspeed-pos:lightspeed-pos-reservations-for-platforms-api
  name: Lightspeed Reservations for Platforms API
  description: The Reservations for Platforms API from Lightspeed — 11 operation(s) for reservations for platforms.
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://x-series-api.lightspeedhq.com/api/2.0
  tags:
  - Reservations for Platforms
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-pos-reservations-for-platforms-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/
  - type: Documentation
    url: https://developers.lightspeedhq.com/retail/introduction/introduction/
  - type: CodeExamples
    url: https://www.postman.com/lightspeedhq/r-series-api/documentation/01jc01h/r-series-collection
  - type: Documentation
    url: https://api-docs.lsk.lightspeed.app/
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
- aid: lightspeed-pos:lightspeed-pos-rich-item-api
  name: Lightspeed Rich Item API
  description: The Rich Item API from Lightspeed — 6 operation(s) for rich item.
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://x-series-api.lightspeedhq.com/api/2.0
  tags:
  - Rich Item
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-pos-rich-item-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/
  - type: Documentation
    url: https://developers.lightspeedhq.com/retail/introduction/introduction/
  - type: CodeExamples
    url: https://www.postman.com/lightspeedhq/r-series-api/documentation/01jc01h/r-series-collection
  - type: Documentation
    url: https://api-docs.lsk.lightspeed.app/
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
- aid: lightspeed-pos:lightspeed-pos-sale-api
  name: Lightspeed Sale API
  description: Point-of-sale transactions and their line items.
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://x-series-api.lightspeedhq.com/api/2.0
  tags:
  - Sale
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-pos-sale-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/
  - type: Documentation
    url: https://developers.lightspeedhq.com/retail/introduction/introduction/
  - type: CodeExamples
    url: https://www.postman.com/lightspeedhq/r-series-api/documentation/01jc01h/r-series-collection
  - type: Documentation
    url: https://api-docs.lsk.lightspeed.app/
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
- aid: lightspeed-pos:lightspeed-pos-sales-api
  name: Lightspeed Sales API
  description: The Sales API from Lightspeed — 2 operation(s) for sales.
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://x-series-api.lightspeedhq.com/api/2.0
  tags:
  - Sales
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-pos-sales-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/
  - type: Documentation
    url: https://developers.lightspeedhq.com/retail/introduction/introduction/
  - type: CodeExamples
    url: https://www.postman.com/lightspeedhq/r-series-api/documentation/01jc01h/r-series-collection
  - type: Documentation
    url: https://api-docs.lsk.lightspeed.app/
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
- aid: lightspeed-pos:lightspeed-pos-staff-api
  name: Lightspeed Staff API
  description: Staff API. Authorisation Code grant type is required for this API with permission ROLE_CONFIG_USERS.
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://x-series-api.lightspeedhq.com/api/2.0
  tags:
  - Staff
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-pos-staff-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/
  - type: Documentation
    url: https://developers.lightspeedhq.com/retail/introduction/introduction/
  - type: CodeExamples
    url: https://www.postman.com/lightspeedhq/r-series-api/documentation/01jc01h/r-series-collection
  - type: Documentation
    url: https://api-docs.lsk.lightspeed.app/
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
- aid: lightspeed-pos:lightspeed-pos-tax-breakdown-api
  name: Lightspeed Tax Breakdown API
  description: The Tax Breakdown API from Lightspeed — 1 operation(s) for tax breakdown.
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://x-series-api.lightspeedhq.com/api/2.0
  tags:
  - Tax Breakdown
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-pos-tax-breakdown-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/
  - type: Documentation
    url: https://developers.lightspeedhq.com/retail/introduction/introduction/
  - type: CodeExamples
    url: https://www.postman.com/lightspeedhq/r-series-api/documentation/01jc01h/r-series-collection
  - type: Documentation
    url: https://api-docs.lsk.lightspeed.app/
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
common:
- type: AgenticAccess
  url: agentic-access/lightspeed-pos-agentic-access.yml
- type: DomainSecurity
  url: security/lightspeed-pos-domain-security.yml
- type: Authentication
  url: authentication/lightspeed-pos-authentication.yml
- type: OAuthScopes
  url: scopes/lightspeed-pos-scopes.yml
- url: https://www.lightspeedhq.com/blog/feed/
  type: Blog
integrations:
- name: NuORDER by Lightspeed
- name: Toolkit
- name: 2ACCEPT Payment Provider -USA
- name: 99minds Inc. Gift Card, Loyalty
- name: Accumula eCommerce, ERP
- name: AdVision eCommerce eCommerce, Marketing
- name: Agendrix Employee Scheduling
- name: Amadeus Hotel PMS
- name: Amaka Accounting
- name: AnyDay Payments, Payroll
- name: APICBASE Analytics, Inventory Management
- name: AppCard Loyalty
- name: Ascent360 Marketing
- name: Astro Loyalty Loyalty, Marketing
- name: Atlas Payments, Payroll, Reporting
- name: Avero Features / Tools, Reporting
- name: Beesly Reporting
- name: Better Chains Workforce
- name: BevSpot Inventory Management, Invoicing
- name: BigCommerce eCommerce
- name: Bike Index Customer Service
- name: bike.rent Manager Rental, Reservation
- name: BikeExchange eCommerce, Inventory Management, Marketing
- name: BirdEye Communication, Customer Service
- name: Bite Digital menus
- name: BlueCheck Age & ID Verification Analytics
- name: Bookingplanner by Stardekk Hotel PMS
- name: Boomtown Features / Tools
- name: BPL Digital Online Ordering Online Ordering
- name: BriteCo Features / Tools
- name: Campspot PMS, Reservation
- name: Capitan Membership Management, Reporting, Scheduling
- name: Chowly Online Ordering
- name: City Hive Loyalty, Online Ordering
- name: Clock Hotel PMS
- name: Cloudbeds Hotel PMS
- name: Como Customer-engagement, Loyalty, Marketing
- name: Cork Guru Digital menus
- name: Courserev AI, Booking
- name: CoverManager Reservation
- name: Dakis Features / Tools, Inventory Management
- name: DataQlick Inventory Management
- name: Datateer Reporting
- name: DAVO Sales Tax Accounting, Reporting
- name: Deputy Employee Scheduling
- name: DigiValet Customer Service, Online Ordering
- name: Dolce Software Scheduling
- name: Dor Analytics, Reporting
- name: DYNE Analytics, Marketing
- name: Eagle Eye Networks AI
- name: Econolease Financial Services Features / Tools
- name: eGolf Waiver Booking
- name: EventPro360 Event Management
- name: EzShop eCommerce
- name: Faire Inventory Management
- name: Flipdish Online Ordering
- name: Formitable Reservation
- name: Freebees Loyalty, Marketing
- name: Fresh Kitchen Display
- name: Frontdesk Anywhere Hotel PMS Hotel PMS
- name: Gift Up! Loyalty, Marketing
- name: Golf Canada Customer Service, Membership Management
- name: Golf Genius Membership Management, Reservation
- name: GolfBack Online Ordering, Reservation
- name: GolfNow Marketing, Reservation
- name: GourmetMiles Analytics, Customer Service, Loyalty, Marketing
- name: Gratuity Solutions Payroll
- name: Growzer Analytics, Inventory Management, Online Ordering
- name: GrubHub Online Ordering
- name: Gusto Payroll
- name: Hostme Online Ordering, Reservation
- name: HotSchedules Workforce
- name: Hubtiger Rental, Reservation, Workorders
- name: Hyperspace Features / Tools
- name: Incentivio Analytics, Customer-engagement, Online Ordering
- name: Infi Kiosk
- name: Infinity Cubed Solutions Procurement Management Services
- name: inKind Loyalty, Payments
- name: INSIGHT from Konnectryx Features / Tools
- name: Kangaroo Rewards eCommerce, Loyalty, Marketing
- name: Kimoby Communication, Customer Service
- name: Klaviyo Customer-engagement, Marketing
- name: Lendio
- name: Lightspeed Delivery by Deliverect Online Ordering
- name: LINK! Data, Migration
- name: Loyal2 Loyalty
- name: LoyalAction Loyalty, Marketing
- name: Loyale eCommerce, Loyalty, Marketing
- name: M2E Cloud eCommerce, Inventory Management, Marketplace
- name: Mailchimp Marketing
- name: MarginEdge Analytics, Inventory Management
- name: MarketMan Inventory Management, Invoicing, Reporting
- name: Marsello Loyalty, Marketing
- name: Maurisource eCommerce
- name: MDware Invoicing for Retail Invoicing
- name: Menufy Online Ordering
- name: MEWS Hotel PMS
- name: Mister eCommerce Marketing
- name: Mobi2Go Online Ordering
- name: Mood Media Customer-engagement
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com