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

Activate Integration for Restaurant

POST /reservation/api/1/user/platform/{platform-code}/integration/activate
OAuth2

Activate the integration between the K-Series business location and the external reservation platform.

Path parameters

  • platform-code string Required

    The unique code assigned to the reservation platform.

    Maximum length is 11. Format should match the following pattern: [a-zA-Z0-9_-]+.

application/json

Body

  • businessLocationId integer(int64) Required

    The K-Series business location ID.

  • platformRestaurantId string Required

    The external platform ID for the restaurant.

    Format should match the following pattern: [a-zA-Z0-9_-]+.

Responses

  • • 200

    Accepted

  • • 400

    Non relevant request

  • • 403

    Access token not relevant for the businessLocation, use authorization-code

  • • 404

    Platform not found

POST /reservation/api/1/user/platform/{platform-code}/integration/activate 
curl \
 -X POST https://api.trial.lsk.lightspeed.app/reservation/api/1/user/platform/EasyTable/integration/activate \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"businessLocationId":9765040300495493,"platformRestaurantId":"Restaurant-123"}'
Request example 
{
  "businessLocationId": 9765040300495493,
  "platformRestaurantId": "Restaurant-123"
}