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

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

Lightspeed Commerce Rich Item 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 Rich Item. 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 10 operations across 6 paths, and defines 14 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.

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.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 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
Get allergens
teckelGetAllergens → 200
GET
/i/locales/{businessId}
Get locales
teckelGetLocales 1 param → 200
PUT
/i/locales/{businessId}
Update locales
teckelUpdateLocales 1 param body → 200
GET
/i/richItem/{businessId}
Get rich items
teckelGetRichItems 4 params → 200
GET
/i/richItem/{businessId}/{sku}
Get rich item by sku
teckelGetRichItem 2 params → 200404
PATCH
/i/richItem/{businessId}/{sku}
Update picture
teckelUpdateRichItemPicture 2 params body → 200
PUT
/i/richItem/{businessId}/{sku}
Create or update rich item
teckelCreateOrUpdateRichItem 2 params body → 200
DELETE
/i/richItem/{businessId}/{sku}
Delete rich item
teckelDeleteRichItem 2 params → 204
POST
/i/richItem/{businessId}/itemsBySkus
Get rich items by SKUs
teckelGetRichItemBySKUs 1 param body → 200
GET
/i/richItem/{businessId}/pictureSpec
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), teckelPictureSpecDto (4 properties), teckelRichItemDto (4 properties), teckelRichItemDtoPictures (3 properties). Each schema is shown below with its type and property counts.

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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