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 Items API

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

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

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

This API exposes 4 operations across 2 paths, and defines 18 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.

4 operations 2 paths 18 schemas 2 GET1 POST1 PUT

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
Resource Areas
1

Authentication & Security 1

Lightspeed Items 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 4

Across 2 paths, the API surfaces 4 operations — 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Items 4
GET
/items/v1/items/{id}
Lightspeed Get Item by ID
items-apiGetItemById 2 params → 200404
PUT
/items/v1/items/{id}
Lightspeed Update Item by ID
items-apiPut 1 param body → 200400
GET
/items/v1/items
Lightspeed Get All Items
items-apiGetItems 7 params → 200400404
POST
/items/v1/items
Lightspeed Create Item
items-apiCreateItem body → 201404

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are items-apiItemDTO (19 properties), items-apiUpdateItemDTO (11 properties), items-apiCreateItemDTO (11 properties), items-apiPriceDTO (2 properties). Each schema is shown below with its type and property counts.

items-apiItemId
integer
The unique identifier for the item.
items-apiBusinessLocationId
integer
The unique identifier for the business location.
items-apiOffset
integer
Offset allows you to retrieve a subset of records starting from a specified position in the dataset. Offset normally works with [amount](operation-getitems-amo…
items-apiDefaultPrice
number
The default price of the item.
items-apiActive
boolean
Indicates whether or not the item is archived from the menu.
items-apiDocketName
string
The name used in the docket for the item.
items-apiCostPrice
number
The cost price of the item.
items-apiPriceMode
string
The type of price for the item.
items-apiUpdateItemDTO
object
11 properties 5 required
items-apiAmount
integer
The number of results to return with each request.
items-apiItemDTO
object
19 properties
items-apiPriceDTO
object
2 properties
items-apiAccountingGroupDTO
object
The accounting group associated with the item.
2 properties
items-apiAccountingGroupId
integer
The unique identifier for the accounting group.
items-apiStatisticGroupDTO
object
2 properties
items-apiCreateItemDTO
object
11 properties 4 required
items-apiSku
string
A stock keeping unit.
items-apiName
string
The name of the item.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightspeed-pos-items-api-openapi.yml Raw ↑

Other APIs Lightspeed publishes across the network.

Lightspeed eCom C-Series API
Lightspeed eCom E-Series API (Ecwid)
Lightspeed Restaurant L-Series API
Lightspeed Restaurant O-Series API (Kounta)
Lightspeed Restaurant G-Series API (Gastrofix)
Lightspeed ChronoGolf Partner API
Lightspeed Account API
Lightspeed Brands API
Lightspeed Catalog API
Lightspeed Customer API
Lightspeed Customers API
Lightspeed Financial API
Where this information came from

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