Lightspeed Commerce

Lightspeed Commerce ID Cards API

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

GitHub OpenAPI

Operations 2

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /id-cards/v1/business-locations/{businessLocationId}/batches Create a batch of ID cards · Create an ID Card Batch #
Ask an LLM
“How do I start a new batch of ID cards for a location?”
“What do I need to name a new ID card batch?”
Tell an agent
Create an ID card batch named {name} at location {businessLocationId}.
Start a new ID card batch {name} for business location {businessLocationId}.
POST /id-cards/v1/business-locations/{businessLocationId}/batches/{batchId}/cards Generate ID cards in an existing batch · Create ID Cards #
Ask an LLM
“How do I generate a number of ID cards inside a batch?”
“Can I add more cards to an ID card batch I already created?”
Tell an agent
Create {cardCount} ID cards in batch {batchId} at location {businessLocationId}.
Generate {cardCount} more cards for existing batch {batchId} at location {businessLocationId}.

Documentation

📖
Documentation
https://x-series-api.lightspeedhq.com/docs/introduction
📖
APIReference
https://x-series-api.lightspeedhq.com/reference
📖
GettingStarted
https://x-series-api.lightspeedhq.com/docs/quick_start
📖
Documentation
https://api-portal.lsk.lightspeed.app/
📖
APIReference
https://api-docs.lsk.lightspeed.app/
📖
GettingStarted
https://api-portal.lsk.lightspeed.app/quick-start/intro

Specifications

⚙
OpenAPI
https://artifacts.apis.io/lightspeed/openapi/lightspeed-id-cards-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/lightspeed/json-schema/lightspeed-id-cards-api-id-card-batch-schema.json
📊
JSONSchema
https://artifacts.apis.io/lightspeed/json-schema/lightspeed-id-cards-api-create-id-cards-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/lightspeed/json-schema/lightspeed-id-cards-api-create-id-cards-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/lightspeed/json-schema/lightspeed-id-cards-api-create-id-card-batch-request-schema.json

Other Resources

🔗
ChangeLog
https://x-series-api.lightspeedhq.com/changelog
🔗
LLMsTxt
https://artifacts.apis.io/lightspeed/llms/lightspeed-llms.txt
🔗
SignUp
https://developers.retail.lightspeed.app/register
🔗
ChangeLog
https://api-docs.lsk.lightspeed.app/changes

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/lightspeed:lightspeed-id-cards-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

lightspeed-id-cards-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Lightspeed ID Cards API
  version: 1.0.0
  x-logo:
    altText: Lightspeed Commerce
    url: static/lightspeed@2x.png
  description: 'Operations tagged ID Cards across 2 of this provider''s published API definitions: lightspeed-k-series-openapi.json, lightspeed-k-series-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.trial.lsk.lightspeed.app
  description: Demo URL
  x-bump-branch-name: demo
- url: https://api.lsk.lightspeed.app
  description: Production URL
  x-bump-branch-name: prod
tags:
- name: ID Cards
paths:
  /id-cards/v1/business-locations/{businessLocationId}/batches:
    post:
      summary: Create an ID Card Batch
      description: Creates a new batch of ID cards for a specific business location.
      operationId: id-cards-apiCreateIdCardBatch
      x-beta: true
      security:
      - OAuth2:
        - id-cards
      parameters:
      - $ref: '#/components/parameters/id-cards-apiBusinessLocationId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/id-cards-apiCreateIdCardBatchRequest'
      responses:
        '201':
          description: Successfully created an ID card batch.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/id-cards-apiIdCardBatch'
      tags:
      - ID Cards
    servers:
    - url: https://api.trial.lsk.lightspeed.app
      description: Demo URL
      x-bump-branch-name: demo
    - url: https://api.lsk.lightspeed.app
      description: Production URL
      x-bump-branch-name: prod
  /id-cards/v1/business-locations/{businessLocationId}/batches/{batchId}/cards:
    post:
      summary: Create ID Cards
      description: Creates a specified number of ID cards for an existing ID card batch.
      operationId: id-cards-apiCreateIdCards
      x-beta: true
      security:
      - OAuth2:
        - id-cards
      parameters:
      - $ref: '#/components/parameters/id-cards-apiBusinessLocationId'
      - name: batchId
        in: path
        required: true
        description: The unique identifier for the ID card batch.
        schema:
          type: integer
          format: int64
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/id-cards-apiCreateIdCardsRequest'
      responses:
        '201':
          description: Successfully created ID cards.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/id-cards-apiCreateIdCardsResponse'
      tags:
      - ID Cards
    servers:
    - url: https://api.trial.lsk.lightspeed.app
      description: Demo URL
      x-bump-branch-name: demo
    - url: https://api.lsk.lightspeed.app
      description: Production URL
      x-bump-branch-name: prod
components:
  schemas:
    id-cards-apiCreateIdCardsResponse:
      type: object
      properties:
        batchId:
          type: integer
          format: int64
          description: The unique identifier for the batch the cards were added to.
          example: 12345
        cards:
          type: array
          items:
            $ref: '#/components/schemas/id-cards-apiCardReference'
    id-cards-apiCreateIdCardsRequest:
      type: object
      properties:
        cardCount:
          type: integer
          format: int32
          description: The number of ID cards to create.
          example: 1
          minimum: 1
          maximum: 100
      required:
      - cardCount
    id-cards-apiCardReference:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: The unique identifier for the ID card.
          example: 98765
        consumerRecordId:
          type: integer
          format: int64
          description: The unique identifier for the associated consumer record.
          example: 54321
        consumerId:
          type: integer
          format: int64
          description: The unique identifier for the associated consumer.
          example: 13579
        url:
          type: string
          description: The URL for the QR code associated with the ID card.
          example: https://example.com/id-cards/98765/qr-code
    id-cards-apiCreateIdCardBatchRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the ID card batch.
          example: Sample Batch Name
          pattern: .*\S.*
          maxLength: 255
      required:
      - name
    id-cards-apiIdCardBatch:
      type: object
      properties:
        batchId:
          type: integer
          format: int64
          description: The unique identifier for the ID card batch.
          example: 12345
        name:
          type: string
          description: The name of the ID card batch.
        businessLocationId:
          type: integer
          format: int64
          description: The unique identifier for the business location this batch belongs to.
          example: 67890
  parameters:
    id-cards-apiBusinessLocationId:
      name: businessLocationId
      in: path
      required: true
      description: The unique identifier for the business location.
      schema:
        type: integer
        format: int64
  securitySchemes:
    OAuth2:
      description: 'The Lightspeed Restaurant K-Series APIs support OAuth2 authentication using the [authorization code grant flow](https://www.oauth.com/oauth2-servers/server-side-apps/authorization-code/).

        See our [Authorization Quick Start Guide](https://api-portal.lsk.lightspeed.app/quick-start/authentication/authorization-overview) for more details on how to authenticate.

        '
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /oauth/authorize
          tokenUrl: /oauth/token
          scopes:
            orders-api: 'Read business information, floors, menus, discounts, and production instructions.

              Read and write orders and payments. Read [Rich Item](https://api-docs.lsk.lightspeed.app/prod/group/endpoint-rich-item) data.'
            financial-api: Read financial data
            reservation-***: Platform reservations scope. The `***` will be replaced by the [platform-code](https://api-docs.lsk.lightspeed.app/operation/operation-reservation-servicesetbyplatformcode#operation-reservation-servicesetbyplatformcode-platform-code) of the reservation platform.
            items: Read and write items
            propertymanagement: Read and write Property Management System configurations.
            id-cards: Create and manage ID card batches and cards.
            staff-api: Read shift information, read and write user information.
            reservations-api: 'Configure *legacy* reservation integrations.

              **Note:** This API will eventually be deprecated in favour of the new [Reservations for Platforms](https://api-docs.lsk.lightspeed.app/group/endpoint-reservations-for-platforms) API.

              More information on the new reservations workflows can be found in the [Integration Guide](https://api-portal.lsk.lightspeed.app/category/reservations).'
x-refined-from:
- lightspeed-k-series-openapi.json
- lightspeed-k-series-openapi.yml
x-tagGroups:
- name: Rich Item API
  tags:
  - Rich Item
  - Migration
- name: Tax Preview API
  tags:
  - Tax Breakdown
- name: Staff Api
  tags:
  - Staff
  - Internal Staff
- name: Reservation API
  tags:
  - Reservations for Platforms
- name: PMS API
  tags:
  - PMS
- name: Items API
  tags:
  - Items
  - ItemsV2
  - Menus
  - Buttons
  - Production Instructions
  - Inventory
  - Combos
  - Groups
  - MenusV2
  - Accounting Group
  - IntegrationMenu
  - Price Lists
  - Products
  - ItemAppearance
  - Modifiers
  - ModifierGroups
  - Allergens
  - Locales
  - RichItem
- name: id-cards-api API
  tags:
  - ID Cards
- name: Financial API
  tags:
  - Financial
  - FinancialV2
- name: Online Ordering API
  tags:
  - Order and Pay
  - 'Order and Pay: Webhook'