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 Error notification

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

Returns an example of error notification sent to the errorsWebhookUrl 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
    • errorMessage string Required

      Error description in english language.

    • traceId string Required

      Unique ID of the issue.

    • httpCode integer(int32) Required

      The code of http error (4xx, 5xx) response.

    • entityType Required

      The type of entity with which the error occurred.

      Values are business-location, general, platform-profile, platform-restaurant, or platform-reservation.

    • errorCode string Required

      The error that can be caused through the Reservation API.

      Values are PLATFORM_NOT_FOUND, URL_MUST_START_WITH_HTTPS, BEARER_AUTH_TTL_IS_EXPIRED, BASIC_AUTH_FIELDS_CAN_NOT_BE_EMPTY, BEARER_AUTH_FIELDS_CAN_NOT_BE_EMPTY, API_KEY_AUTH_FIELDS_CAN_NOT_BE_EMPTY, OAUTH_FIELDS_CAN_NOT_BE_EMPTY, RESTAURANT_PROPERTIES_REQUIRED, RESTAURANT_PROPERTIES_INVALID, RESTAURANT_PROPERTIES_EXPIRED, INTEGRATION_LOCATION_ID_MISMATCH, PLATFORM_ALREADY_ACTIVATED, CURRENCY_NOT_ACCEPTABLE, PLATFORM_FIELDS_CAN_NOT_BE_EMPTY, PLATFORM_CODE_TOO_MANY_SYMBOLS, REQUESTED_TABLE_IS_UNAVAILABLE, PLATFORM_RESTAURANT_NOT_FOUND, PLATFORM_PROPERTIES_INVALID, RESERVATION_FIELDS_CAN_NOT_BE_EMPTY, RESERVATION_ID_TOO_MANY_SYMBOLS, RESERVATION_PARTY_SIZE_ERROR, RESERVATION_SEQUENCE_ID_ERROR, RESERVATION_PROPERTIES_INVALID, GUEST_URL_UNREACHABLE, GUEST_PROPERTIES_INVALID, GUEST_FIELDS_CAN_NOT_BE_EMPTY, VOIDED_DEPOSIT_CAN_NOT_BE_FUNDED_AGAIN, DEPOSIT_AMOUNT_CAN_NOT_BE_CHANGED, DEPOSIT_UNACCEPTABLE_AMOUNT, DEPOSIT_ID_MUST_BE_UNIQUE, VOIDED_REFUND_CAN_NOT_BE_REFUNDED_AGAIN, REFUND_AMOUNT_CAN_NOT_BE_CHANGED, REFUND_ID_MUST_BE_UNIQUE, REFUND_UNACCEPTABLE_AMOUNT, CURRENCY_CAN_NOT_BE_CHANGED, TOO_MANY_DEPOSITS, TOO_MANY_REFUNDS, TOO_MANY_INTEGRATIONS_WITH_PLATFORM, INTERNAL_ERROR, ACCOUNT_CREATION_ERROR, CLIENT_REQUEST_ERROR, or INTEGRATION_ONBOARDING_PROPERTIES_INVALID.

    • platformCode string

      The unique code assigned to the reservation platform.

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

    • platformRestaurantId string

      The external platform ID for the restaurant.

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

    • platformReservationId string

      The external platform ID for the reservation.

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

    • errorProperties array[string]

      List of invalid properties according to the provided entity
GET /reservation/api/1/platform/{platform-code}/error-webhook-sample 
curl \
 -X GET https://api.trial.lsk.lightspeed.app/reservation/api/1/platform/EasyTable/error-webhook-sample \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "errorMessage": "Incorrect properties",
  "traceId": "b43f8e3e-5ac9-464e-ab34-20b4e137115e",
  "httpCode": 400,
  "entityType": "platform-reservation",
  "errorCode": "REQUESTED_TABLE_IS_UNAVAILABLE",
  "platformCode": "EasyTable",
  "platformRestaurantId": "Restaurant-123",
  "platformReservationId": "Reservation-123",
  "errorProperties": [
    "tableNumbers"
  ]
}