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

Create PMS provider

POST /pms/v1/providers
OAuth2

Creates a new PMS provider for the businessLocation.

application/json

Body Required

  • businessLocationId integer(int64) Required

    the id of the businessLocation

  • name string Required

    Minimum length is 1, maximum length is 255.

  • endpoint string Required

    Minimum length is 1, maximum length is 255.

  • apiKey string Required

    Minimum length is 1, maximum length is 255.

  • features array[string] Required

    Values are SEARCH_BY_NAME, MIRRORING, PARTIAL_PAYMENTS, MULTI_PAYMENTS, SERVICE_CHARGE, or ENRICHED_PAYLOAD.

Responses

POST /pms/v1/providers 
curl \
 -X POST https://api.trial.lsk.lightspeed.app/pms/v1/providers \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"businessLocationId":45454565682155,"name":"John Smith","endpoint":"http://integration.com/pms/endpoint","apiKey":"secret-1234","features":["MIRRORING"]}'
Request example 
{
  "businessLocationId": 45454565682155,
  "name": "John Smith",
  "endpoint": "http://integration.com/pms/endpoint",
  "apiKey": "secret-1234",
  "features": [
    "MIRRORING"
  ]
}
Response examples (200) 
{
  "id": 3012455645,
  "businessLocationId": 45454565682155,
  "name": "John Smith",
  "endpoint": "http://integration.com/pms/endpoint",
  "apiKey": "secret-1234",
  "features": [
    "MIRRORING"
  ]
}
Response examples (400) 
{
  "status": "string",
  "timestamp": "2024-05-04T09:42:00+00:00",
  "message": "string",
  "apiSubExceptions": [
    {
      "field": "string",
      "rejectedValue": {},
      "message": "string"
    }
  ]
}
Response examples (403) 
{
  "status": "string",
  "timestamp": "2024-05-04T09:42:00+00:00",
  "message": "string",
  "apiSubExceptions": [
    {
      "field": "string",
      "rejectedValue": {},
      "message": "string"
    }
  ]
}
Response examples (404) 
{
  "status": "string",
  "timestamp": "2024-05-04T09:42:00+00:00",
  "message": "string",
  "apiSubExceptions": [
    {
      "field": "string",
      "rejectedValue": {},
      "message": "string"
    }
  ]
}
Response examples (503) 
{
  "status": "string",
  "timestamp": "2024-05-04T09:42:00+00:00",
  "message": "string",
  "apiSubExceptions": [
    {
      "field": "string",
      "rejectedValue": {},
      "message": "string"
    }
  ]
}