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 ID Cards API

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

Lightspeed Commerce ID Cards 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 ID Cards. 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 2 operations across 2 paths, and defines 5 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.

2 operations 2 paths 5 schemas 2 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 ID Cards 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 2

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

ID Cards 2
POST
/id-cards/v1/business-locations/{businessLocationId}/batches
Create an ID Card Batch
id-cards-apiCreateIdCardBatch 1 param body → 201
POST
/id-cards/v1/business-locations/{businessLocationId}/batches/{batchId}/cards
Create ID Cards
id-cards-apiCreateIdCards 2 params body → 201

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are id-cards-apiCardReference (4 properties), id-cards-apiIdCardBatch (3 properties), id-cards-apiCreateIdCardsResponse (2 properties), id-cards-apiCreateIdCardBatchRequest (1 property). Each schema is shown below with its type and property counts.

id-cards-apiCreateIdCardsRequest
object
1 property 1 required
id-cards-apiCreateIdCardsResponse
object
2 properties
id-cards-apiCreateIdCardBatchRequest
object
1 property 1 required
id-cards-apiCardReference
object
4 properties
id-cards-apiIdCardBatch
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightspeed-id-cards-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 ID Cards 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.