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 Sample Integration notification

GET /reservation/api/1/platform/{platform-code}/integration-webhook-sample
OAuth2

Returns an example of customer's integration notification sent to the integrationWebhookUrl field.

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_-]+.

Responses

  • • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • notificationType string Required

      Values are ACTIVATED or DEACTIVATED.

    • platformCode string Required

      The unique code assigned to the reservation platform.

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

    • 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_-]+.
GET /reservation/api/1/platform/{platform-code}/integration-webhook-sample 
curl \
 -X GET https://api.trial.lsk.lightspeed.app/reservation/api/1/platform/EasyTable/integration-webhook-sample \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "notificationType": "ACTIVATED",
  "platformCode": "EasyTable",
  "businessLocationId": 9765040300495493,
  "platformRestaurantId": "Restaurant-123"
}