Lightspeed Restaurant K Series API
1.0.0

Lightspeed Restaurant offers a REST API in order to communicate with the data in the system. These APIs are built using the RESTful standards and adhere to the basic verb interactions as defined by the REST standard.

These services are in continuous development and subject to change. Find our versioning policy here.

This is the documentation for version 1.0.0 of the API. Last update on May 1, 2024.

Base URL 
https://api.trial.lsk.lightspeed.app

Get Floorplans

GET /o/op/data/{businessLocationId}/floorplans
OAuth2

Returns the floorplans for a specific business location.

Path parameters

Responses

  • • 200 application/json

    Floorplans

    Hide response attributes Show response attributes object
    • id integer(int64)

      The floor plan ID.

    • name string

      The name of this floorplan.

    • tables array[object]

      The tables under this floor plan.

      Hide tables attributes Show tables attributes object
  • • 404

    Not Found

    Indicates that the business location has no floor plans configured.

GET /o/op/data/{businessLocationId}/floorplans 
curl \
 -X GET https://api.trial.lsk.lightspeed.app/o/op/data/45454565682155/floorplans \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
[
  {
    "id": 141948669132976,
    "name": "Terrace",
    "tables": [
      {
        "number": 1,
        "reference": "abcdefg123456",
        "id": "141948669132977",
        "active": true,
        "description": "Table 1",
        "defaultClientCount": 4
      }
    ]
  }
]