LIlightspeed
Order and Pay

Get All Floorplans

Changed on

Returns the floorplans for a specific business location.

get/o/op/data/{businessLocationId}/floorplans

Request

  • Base URL
    https://api.trial.lsk.lightspeed.app
  • URL
    https://api.trial.lsk.lightspeed.app/o/op/data/{businessLocationId}/floorplans
  • Auth
    OAuth 2
    Authorization code: https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/auth
    Token URL: https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/token scopes: orders-api

Path parameters

businessLocationIdinteger required

The unique identifier for the business location.

Example:45454565682155

Query parameters

expandTablesboolean

If true, the response will include the table details for each floorplan. If false, the response will only include the name and id for the floorplans.

Response

Floorplans

idinteger

The unique identifier for the floorplan.

namestring

The name of the floorplan.

Example response

[
  {
    "id": 141948669132976,
    "name": "Terrace",
    "tables": [
      {
        "number": 1,
        "reference": "abcdefg123456",
        "id": "141948669132977",
        "active": true,
        "description": "Table 1",
        "defaultClientCount": 4
      }
    ]
  }
]

Changes