Lightspeed website screenshot

Lightspeed

Lightspeed (Lightspeed Commerce) operates a portfolio of Retail, Restaurant, eCom, and Golf POS platforms via series-named product lines: X-Series (Vend), R-Series (Retail Pro/Cloud), C-Series (eCom), E-Series (Ecwid), K-Series (Restaurant Lightspeed), L-Series, O-Series (Kounta), G-Series (Gastrofix), and the ChronoGolf Partner API.

9 APIs 0 Features
POSRetailRestaurantEcommerce

APIs

Lightspeed Retail X-Series API (Vend)

REST API for Lightspeed Retail X-Series, formerly Vend. Covers products, customers, sales, inventory, suppliers, registers, taxes, and outlets.

Lightspeed Retail R-Series API

REST API for Lightspeed Retail R-Series (Retail Pro / Cloud). Covers items, sales, customers, employees, shops, and inventory.

Lightspeed eCom C-Series API

REST API for the Lightspeed eCom C-Series storefront platform.

Lightspeed eCom E-Series API (Ecwid)

REST API for Ecwid-powered Lightspeed eCom E-Series stores.

Lightspeed Restaurant K-Series API

REST API for Lightspeed Restaurant K-Series, the flagship cloud restaurant POS. Covers items and rich items, menus, modifiers and discounts, orders (Order & Pay), checks and pay...

Lightspeed Restaurant L-Series API

REST API for the Lightspeed Restaurant L-Series cloud POS.

Lightspeed Restaurant O-Series API (Kounta)

REST API for Lightspeed Restaurant O-Series (Kounta).

Lightspeed Restaurant G-Series API (Gastrofix)

REST API for Lightspeed Restaurant G-Series (Gastrofix).

Lightspeed ChronoGolf Partner API

Partner API for ChronoGolf, Lightspeed's tee-time and course management platform.

Collections

Pricing Plans

Rate Limits

Lightspeed Pos Rate Limits

4 limits

RATE LIMITS

FinOps

Semantic Vocabularies

Lightspeed Pos Restaurant K Series Context

69 classes · 346 properties

JSON-LD

Lightspeed Pos Retail R Series Context

10 classes · 53 properties

JSON-LD

Lightspeed Pos Retail X Series Context

4 classes · 23 properties

JSON-LD

API Governance Rules

Lightspeed API Rules

28 rules · 6 errors 12 warnings 10 info

SPECTRAL

JSON Structure

Restaurant K Series Ape Discount Structure

4 properties

JSON STRUCTURE

Restaurant K Series Ape Menu Structure

5 properties

JSON STRUCTURE

Restaurant K Series Ape Menu V2 Structure

5 properties

JSON STRUCTURE

Restaurant K Series Ape Table Structure

6 properties

JSON STRUCTURE

Restaurant K Series Staff Api Shift Structure

8 properties

JSON STRUCTURE

Restaurant K Series Staff Api Staff Structure

15 properties

JSON STRUCTURE

Retail R Series Account Structure

3 properties

JSON STRUCTURE

Retail R Series Attributes Structure

3 properties

JSON STRUCTURE

Retail R Series Category Structure

4 properties

JSON STRUCTURE

Retail R Series Contact Structure

5 properties

JSON STRUCTURE

Retail R Series Customer Structure

8 properties

JSON STRUCTURE

Retail R Series Employee Structure

5 properties

JSON STRUCTURE

Retail R Series Item Structure

13 properties

JSON STRUCTURE

Retail R Series Manufacturer Structure

2 properties

JSON STRUCTURE

Retail R Series Sale Line Structure

7 properties

JSON STRUCTURE

Retail R Series Sale Structure

12 properties

JSON STRUCTURE

Retail R Series Shop Structure

4 properties

JSON STRUCTURE

Retail R Series Vendor Structure

4 properties

JSON STRUCTURE

Retail X Series Brand Structure

4 properties

JSON STRUCTURE

Retail X Series Customer Structure

6 properties

JSON STRUCTURE

Retail X Series Product Structure

9 properties

JSON STRUCTURE

Retail X Series Sale Structure

9 properties

JSON STRUCTURE

Example Payloads

Retail R Series Item Example

13 fields

EXAMPLE

Retail R Series Sale Example

12 fields

EXAMPLE

Retail R Series Shop Example

4 fields

EXAMPLE

Retail X Series Sale Example

9 fields

EXAMPLE

Resources

🔗
LinkedIn
LinkedIn
🔗
Website
Website
🔗
Developer
Developer
🔗
Plans
Plans
🔗
RateLimits
RateLimits
🔗
FinOps
FinOps
👥
GitHubOrganization
GitHubOrganization
📦
Lightspeed Payments Online Payments SDK (npm)
SDKs
🔗
Spectral
Spectral
🔗
Vocabulary
Vocabulary

Sources

Raw ↑
opencollection: 1.0.0
info:
  name: Lightspeed Retail X-Series API
  version: 2.0.0
request:
  auth:
    type: oauth2
    flow: authorization_code
    authorizationUrl: https://secure.retail.lightspeed.app/connect
    accessTokenUrl: https://{domainPrefix}.retail.lightspeed.app/api/1.0/token
    credentials:
      clientId: '{{clientId}}'
      clientSecret: '{{clientSecret}}'
items:
- info:
    name: Lightspeed List Brands
    type: http
  http:
    method: GET
    url: https://{domainPrefix}.retail.lightspeed.app/api/2.0/brands
    params:
    - name: page_size
      value: ''
      type: query
    - name: after
      value: ''
      type: query
      description: Cursor for paging.
    auth:
      type: oauth2
      flow: authorization_code
      authorizationUrl: https://secure.retail.lightspeed.app/connect
      accessTokenUrl: https://{domainPrefix}.retail.lightspeed.app/api/1.0/token
      credentials:
        clientId: '{{clientId}}'
        clientSecret: '{{clientSecret}}'
  docs: Lightspeed List Brands
- info:
    name: Lightspeed Create a Brand
    type: http
  http:
    method: POST
    url: https://{domainPrefix}.retail.lightspeed.app/api/2.0/brands
    body:
      type: json
      data: '{}'
    auth:
      type: oauth2
      flow: authorization_code
      authorizationUrl: https://secure.retail.lightspeed.app/connect
      accessTokenUrl: https://{domainPrefix}.retail.lightspeed.app/api/1.0/token
      credentials:
        clientId: '{{clientId}}'
        clientSecret: '{{clientSecret}}'
  docs: Lightspeed Create a Brand
- info:
    name: Lightspeed Get a Brand by ID
    type: http
  http:
    method: GET
    url: https://{domainPrefix}.retail.lightspeed.app/api/2.0/brands/:id
    params:
    - name: id
      value: ''
      type: path
    auth:
      type: oauth2
      flow: authorization_code
      authorizationUrl: https://secure.retail.lightspeed.app/connect
      accessTokenUrl: https://{domainPrefix}.retail.lightspeed.app/api/1.0/token
      credentials:
        clientId: '{{clientId}}'
        clientSecret: '{{clientSecret}}'
  docs: Lightspeed Get a Brand by ID
- info:
    name: Lightspeed Update a Brand
    type: http
  http:
    method: PUT
    url: https://{domainPrefix}.retail.lightspeed.app/api/2.0/brands/:id
    params:
    - name: id
      value: ''
      type: path
    body:
      type: json
      data: '{}'
    auth:
      type: oauth2
      flow: authorization_code
      authorizationUrl: https://secure.retail.lightspeed.app/connect
      accessTokenUrl: https://{domainPrefix}.retail.lightspeed.app/api/1.0/token
      credentials:
        clientId: '{{clientId}}'
        clientSecret: '{{clientSecret}}'
  docs: Lightspeed Update a Brand
- info:
    name: Lightspeed Delete a Brand
    type: http
  http:
    method: DELETE
    url: https://{domainPrefix}.retail.lightspeed.app/api/2.0/brands/:id
    params:
    - name: id
      value: ''
      type: path
    auth:
      type: oauth2
      flow: authorization_code
      authorizationUrl: https://secure.retail.lightspeed.app/connect
      accessTokenUrl: https://{domainPrefix}.retail.lightspeed.app/api/1.0/token
      credentials:
        clientId: '{{clientId}}'
        clientSecret: '{{clientSecret}}'
  docs: Lightspeed Delete a Brand
- info:
    name: Lightspeed List Products
    type: http
  http:
    method: GET
    url: https://{domainPrefix}.retail.lightspeed.app/api/2.0/products
    params:
    - name: page_size
      value: ''
      type: query
    auth:
      type: oauth2
      flow: authorization_code
      authorizationUrl: https://secure.retail.lightspeed.app/connect
      accessTokenUrl: https://{domainPrefix}.retail.lightspeed.app/api/1.0/token
      credentials:
        clientId: '{{clientId}}'
        clientSecret: '{{clientSecret}}'
  docs: Lightspeed List Products
- info:
    name: Lightspeed Create a Product
    type: http
  http:
    method: POST
    url: https://{domainPrefix}.retail.lightspeed.app/api/2.0/products
    body:
      type: json
      data: '{}'
    auth:
      type: oauth2
      flow: authorization_code
      authorizationUrl: https://secure.retail.lightspeed.app/connect
      accessTokenUrl: https://{domainPrefix}.retail.lightspeed.app/api/1.0/token
      credentials:
        clientId: '{{clientId}}'
        clientSecret: '{{clientSecret}}'
  docs: Lightspeed Create a Product
- info:
    name: Lightspeed Get a Product by ID
    type: http
  http:
    method: GET
    url: https://{domainPrefix}.retail.lightspeed.app/api/2.0/products/:id
    params:
    - name: id
      value: ''
      type: path
    auth:
      type: oauth2
      flow: authorization_code
      authorizationUrl: https://secure.retail.lightspeed.app/connect
      accessTokenUrl: https://{domainPrefix}.retail.lightspeed.app/api/1.0/token
      credentials:
        clientId: '{{clientId}}'
        clientSecret: '{{clientSecret}}'
  docs: Lightspeed Get a Product by ID
- info:
    name: Lightspeed Update a Product
    type: http
  http:
    method: PUT
    url: https://{domainPrefix}.retail.lightspeed.app/api/2.0/products/:id
    params:
    - name: id
      value: ''
      type: path
    body:
      type: json
      data: '{}'
    auth:
      type: oauth2
      flow: authorization_code
      authorizationUrl: https://secure.retail.lightspeed.app/connect
      accessTokenUrl: https://{domainPrefix}.retail.lightspeed.app/api/1.0/token
      credentials:
        clientId: '{{clientId}}'
        clientSecret: '{{clientSecret}}'
  docs: Lightspeed Update a Product
- info:
    name: Lightspeed List Sales
    type: http
  http:
    method: GET
    url: https://{domainPrefix}.retail.lightspeed.app/api/2.0/sales
    auth:
      type: oauth2
      flow: authorization_code
      authorizationUrl: https://secure.retail.lightspeed.app/connect
      accessTokenUrl: https://{domainPrefix}.retail.lightspeed.app/api/1.0/token
      credentials:
        clientId: '{{clientId}}'
        clientSecret: '{{clientSecret}}'
  docs: Lightspeed List Sales
- info:
    name: Lightspeed Create a Sale
    type: http
  http:
    method: POST
    url: https://{domainPrefix}.retail.lightspeed.app/api/2.0/sales
    body:
      type: json
      data: '{}'
    auth:
      type: oauth2
      flow: authorization_code
      authorizationUrl: https://secure.retail.lightspeed.app/connect
      accessTokenUrl: https://{domainPrefix}.retail.lightspeed.app/api/1.0/token
      credentials:
        clientId: '{{clientId}}'
        clientSecret: '{{clientSecret}}'
  docs: Lightspeed Create a Sale
- info:
    name: Lightspeed Get a Sale by ID
    type: http
  http:
    method: GET
    url: https://{domainPrefix}.retail.lightspeed.app/api/2.0/sales/:id
    params:
    - name: id
      value: ''
      type: path
    auth:
      type: oauth2
      flow: authorization_code
      authorizationUrl: https://secure.retail.lightspeed.app/connect
      accessTokenUrl: https://{domainPrefix}.retail.lightspeed.app/api/1.0/token
      credentials:
        clientId: '{{clientId}}'
        clientSecret: '{{clientSecret}}'
  docs: Lightspeed Get a Sale by ID
- info:
    name: Lightspeed List Customers
    type: http
  http:
    method: GET
    url: https://{domainPrefix}.retail.lightspeed.app/api/2.0/customers
    auth:
      type: oauth2
      flow: authorization_code
      authorizationUrl: https://secure.retail.lightspeed.app/connect
      accessTokenUrl: https://{domainPrefix}.retail.lightspeed.app/api/1.0/token
      credentials:
        clientId: '{{clientId}}'
        clientSecret: '{{clientSecret}}'
  docs: Lightspeed List Customers
- info:
    name: Lightspeed Create a Customer
    type: http
  http:
    method: POST
    url: https://{domainPrefix}.retail.lightspeed.app/api/2.0/customers
    body:
      type: json
      data: '{}'
    auth:
      type: oauth2
      flow: authorization_code
      authorizationUrl: https://secure.retail.lightspeed.app/connect
      accessTokenUrl: https://{domainPrefix}.retail.lightspeed.app/api/1.0/token
      credentials:
        clientId: '{{clientId}}'
        clientSecret: '{{clientSecret}}'
  docs: Lightspeed Create a Customer
- info:
    name: Lightspeed Get a Customer by ID
    type: http
  http:
    method: GET
    url: https://{domainPrefix}.retail.lightspeed.app/api/2.0/customers/:id
    params:
    - name: id
      value: ''
      type: path
    auth:
      type: oauth2
      flow: authorization_code
      authorizationUrl: https://secure.retail.lightspeed.app/connect
      accessTokenUrl: https://{domainPrefix}.retail.lightspeed.app/api/1.0/token
      credentials:
        clientId: '{{clientId}}'
        clientSecret: '{{clientSecret}}'
  docs: Lightspeed Get a Customer by ID
- info:
    name: Lightspeed List Gift Cards
    type: http
  http:
    method: GET
    url: https://{domainPrefix}.retail.lightspeed.app/api/2.0/gift_cards
    auth:
      type: oauth2
      flow: authorization_code
      authorizationUrl: https://secure.retail.lightspeed.app/connect
      accessTokenUrl: https://{domainPrefix}.retail.lightspeed.app/api/1.0/token
      credentials:
        clientId: '{{clientId}}'
        clientSecret: '{{clientSecret}}'
  docs: Lightspeed List Gift Cards
- info:
    name: Lightspeed Create a Gift Card
    type: http
  http:
    method: POST
    url: https://{domainPrefix}.retail.lightspeed.app/api/2.0/gift_cards
    body:
      type: json
      data: '{}'
    auth:
      type: oauth2
      flow: authorization_code
      authorizationUrl: https://secure.retail.lightspeed.app/connect
      accessTokenUrl: https://{domainPrefix}.retail.lightspeed.app/api/1.0/token
      credentials:
        clientId: '{{clientId}}'
        clientSecret: '{{clientSecret}}'
  docs: Lightspeed Create a Gift Card
bundled: true