Skip to main content

Reservation API Specification (1.0.0)

Download OpenAPI specification:Download

This OpenAPI document describes the Lightspeed Restaurant K-Series Reservation API

Reservation

Get a list of all the reservations for a time period

query Parameters
restaurantId
required
string

ID of the restaurant in the reservation provider system

from
required
string <date-time>

local date from which we want to retrieve the reservations (format:YYYY-MM-DDTHH:mm:ss)

until
required
string <date-time>

local date until which we want to retrieve the reservations (format:YYYY-MM-DDTHH:mm:ss)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update a reservation

path Parameters
reservationId
required
string

ID of the reservation to update

Request Body schema: application/json

Content of the reservation to be updated

status
string (ReservationStatus)
Enum: "CONFIRMED" "SEATED" "PAID" "DEPARTED" "CANCELLED"

Reservation Status

tableNumber
string

Responses

Request samples

Content type
application/json
{
  • "status": "CONFIRMED",
  • "tableNumber": "string"
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "code": "string",
  • "message": "string"
}