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 Rich Item API

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

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

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

This API exposes 10 operations across 6 paths, and defines 14 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.

10 operations 6 paths 14 schemas 1 DELETE5 GET1 PATCH1 POST2 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 Rich Item 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 10

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

Rich Item 10
GET
/i/allergens
Lightspeed Get Allergens
teckelGetAllergens → 200
GET
/i/locales/{businessId}
Lightspeed Get Locales
teckelGetLocales 1 param → 200
PUT
/i/locales/{businessId}
Lightspeed Update Locales
teckelUpdateLocales 1 param body → 200201
GET
/i/richItem/{businessId}
Lightspeed Get Rich Items
teckelGetRichItems 4 params → 200
GET
/i/richItem/{businessId}/{sku}
Lightspeed Get Rich Item by Sku
teckelGetRichItem 2 params → 200404
PATCH
/i/richItem/{businessId}/{sku}
Lightspeed Update Picture
teckelUpdateRichItemPicture 2 params body → 200
PUT
/i/richItem/{businessId}/{sku}
Lightspeed Create or Update Rich Item
teckelCreateOrUpdateRichItem 2 params body → 200
DELETE
/i/richItem/{businessId}/{sku}
Lightspeed Delete Rich Item
teckelDeleteRichItem 2 params → 204
POST
/i/richItem/{businessId}/itemsBySkus
Lightspeed Get Rich Items by SKUs
teckelGetRichItemBySKUs 1 param body → 200
GET
/i/richItem/{businessId}/pictureSpec
Lightspeed Get Picture Specifications
teckelGetRichItemPictureSpec 1 param → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are teckelLink (8 properties), teckelRichItemDto (4 properties), teckelPictureSpecDto (4 properties), teckelRichItemDtoPictures (3 properties). Each schema is shown below with its type and property counts.

teckelLinkSelf
object
1 property
teckelLink
object
8 properties
teckelLinkSelfPage
object
1 property
teckelRichItemDtoPictures
object
3 properties
teckelSKU
string
The SKU of the item.
teckelRichItemDescriptionDto
object
Stores an item description with its locale code.
3 properties 1 required
teckelBusinessId
integer
The unique identifier for the business.
teckelLinks
object
teckelRichItemDtoDates
object
2 properties
teckelLinkItems
object
1 property
teckelRichItemDtoLinks
object
1 property
teckelRichItemDto
object
4 properties
teckelLocalesDto
array
A list of locales.
teckelPictureSpecDto
object
Contains picture requirements.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightspeed-pos-rich-item-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 Rich Item 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.