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

Seating of a reservation Deprecated

POST /r/reservation/1/checkin

OAuth2

Assign a reservation to a table

application/json

Body Required

businessLocationId integer(int64) Required

Business Location ID as defined in K-series
customerCount integer(int32)

Number of seats for the reservation
customerInfo object Required

Basic customer information
Hide customerInfo attributes Show customerInfo attributes
- contactNumberAsE164 string
  
  Contact number formatted in E164
- email string Required
- firstName string Required
- lastName string
- notes string
  
  Customer notes
- rating number(float)
- thirdPartyReference string Required
  
  Unique ID for you to tie this customer record back to yours
- vip boolean
endPointId string Required

Identifies the previously registered endpoint to use for Webhook notifications
notes array[object]

An Array of notes
Hide notes attribute Show notes attribute object
- note string
  
  A note to add to the reservation
reservationReference string Required

Unique ID for you to tie the callback events to this action
specialOffer string Deprecated

Deprecated - use notes instead
table string Required

Table name or number

Responses

• 200 application/json

OK
Hide response attributes Show response attributes object
- error boolean
- errorMessage string
- responseEntity object
  
  A JSON object representing the response data

POST /r/reservation/1/checkin

curl \
 -X POST https://api.trial.lsk.lightspeed.app/r/reservation/1/checkin \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"businessLocationId":42,"customerCount":42,"customerInfo":{"contactNumberAsE164":"string","email":"string","firstName":"string","lastName":"string","notes":"string","rating":42.0,"thirdPartyReference":"string","vip":true},"endPointId":"string","notes":[{"note":"string"}],"reservationReference":"string","specialOffer":"string","table":"string"}'

Request example

{
  "businessLocationId": 42,
  "customerCount": 42,
  "customerInfo": {
    "contactNumberAsE164": "string",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "notes": "string",
    "rating": 42.0,
    "thirdPartyReference": "string",
    "vip": true
  },
  "endPointId": "string",
  "notes": [
    {
      "note": "string"
    }
  ],
  "reservationReference": "string",
  "specialOffer": "string",
  "table": "string"
}

Response examples (200)

{
  "error": true,
  "errorMessage": "string",
  "responseEntity": {}
}

Lightspeed Restaurant K Series API 1.0.0

Seating of a reservation Deprecated

Body Required

Responses

Lightspeed Restaurant K Series API
1.0.0