Lightspeed Commerce

Lightspeed Commerce Reservations for Platforms API

The Reservations for Platforms API from Lightspeed Commerce — 11 operation(s) for reservations for platforms.

GitHub OpenAPI

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /reservation/api/1/platform/{platform-code}/integration/onboarding Complete restaurant onboarding for a platform · Callback to Complete Onboarding #
Ask an LLM
“After I receive the onboarding webhook, how do I finish connecting the restaurant?”
“What values do I send back to confirm a reservation platform onboarding?”
Tell an agent
Complete onboarding {onboarding} for platform {platform} with code {code}, location {location} and restaurant {restaurant}.
Send the onboarding callback for platform {platform}, onboarding {onboarding}, code {code}, business location {location}, restaurant {restaurant}.
GET /reservation/api/1/platform/{platform-code}/profile Get a reservation platform's profile · Platform Profile Details #
Ask an LLM
“What webhook URLs and settings are saved on my reservation platform profile?”
“Can I check how my booking platform is currently configured in Lightspeed?”
Tell an agent
Show the profile for reservation platform {platform}.
Get the current webhook settings of platform {platform}.
POST /reservation/api/1/platform/{platform-code}/profile Create or update a reservation platform profile · Create or Update Platform Profile #
Ask an LLM
“How do I register my booking platform with its display name and webhook URLs?”
“Can I declare that my platform supports deposits?”
Tell an agent
Set up platform {platform} with display name {name} and webhook auth type {auth}.
Update platform {platform} to send order webhooks to {url}.
PATCH /reservation/api/1/platform/{platform-code}/course-settings Configure a platform's course settings · Platform course settings definition #
Ask an LLM
“Can my reservation platform be allowed to update course numbers?”
“Which table statuses count as in service for course tracking?”
Tell an agent
Set course number updates for platform {platform} to {allow}.
Set the in-service table statuses for platform {platform} to {statuses}.
PUT /reservation/api/1/platform/{platform-code}/restaurant/{platform-restaurant-id}/reservation/{platform-reservation-id}/push Create or update a reservation · Create or Update Reservation #
Ask an LLM
“How do I push a new booking into the restaurant's POS?”
“Can I update a reservation's party size, status or guest details after it was sent?”
Tell an agent
Push reservation {reservation} for restaurant {restaurant} on platform {platform}: party of {size} at {time}.
Update the status of reservation {reservation} at restaurant {restaurant} via platform {platform} to {status}.
PATCH /reservation/api/1/platform/{platform-code}/webhook/auth/api-keys Secure platform webhooks with an API key · Add authentication by XApiKey #
Ask an LLM
“Can Lightspeed send an X-Api-Key header when calling my reservation webhooks?”
“What is the way to attach API key headers to webhook calls?”
Tell an agent
Turn on API key authentication for platform {platform} webhooks using headers {headers}.
Enable XApiKey webhook auth for platform {platform}.
PATCH /reservation/api/1/platform/{platform-code}/webhook/auth/basic-auth Secure platform webhooks with basic auth · Add authentication with BasicAuth #
Ask an LLM
“Can reservation webhooks be sent with a username and password?”
“Which webhook auth option uses HTTP basic credentials?”
Tell an agent
Enable basic auth on platform {platform} webhooks with username {user} and password {password}.
Protect webhooks for platform {platform} with basic credentials {user} / {password}.
PATCH /reservation/api/1/platform/{platform-code}/webhook/auth/bearer-auth Secure platform webhooks with a bearer token · Add authentication with BearerAuth #
Ask an LLM
“Can webhook calls to my platform carry a bearer token?”
“Is there a way to set how long the webhook bearer token lives?”
Tell an agent
Enable bearer token auth for platform {platform} webhooks with token {token}.
Use bearer token {token} with a TTL of {ttl} for platform {platform} webhooks.
PATCH /reservation/api/1/platform/{platform-code}/webhook/auth/oauth2 Secure platform webhooks with OAuth2 · Add authentication with OAuth2 #
Ask an LLM
“Can Lightspeed fetch an OAuth2 token from my server before calling my webhooks?”
“What client credentials does OAuth2 webhook authentication need?”
Tell an agent
Enable OAuth2 webhook auth for platform {platform} with client {client}, secret {secret} and token URL {token_url}.
Configure OAuth2 for platform {platform} webhooks requesting scopes {scopes}.
GET /reservation/api/1/user/platform/{platform-code}/business-locations List business locations a user can reach · Get Business Locations #
Ask an LLM
“Which restaurant locations does the signed-in user have access to for my platform?”
“Can I page through the business locations available to connect?”
Tell an agent
List the business locations available to platform {platform}.
Show page {page} of accessible business locations for platform {platform}.
POST /reservation/api/1/user/platform/{platform-code}/integration/activate Activate a reservation integration for a restaurant · Activate Integration for Restaurant #
Ask an LLM
“How do I switch on the link between a K-Series location and my booking platform?”
“Can I activate the reservation integration for one restaurant at a time?”
Tell an agent
Activate platform {platform} for business location {location} as restaurant {restaurant}.
Connect restaurant {restaurant} on platform {platform} to location {location}.
POST /reservation/api/1/user/platform/{platform-code}/integration/deactivate Deactivate a reservation integration · Deactivate Integration for Restaurant #
Ask an LLM
“Can I disconnect a restaurant from my reservation platform?”
“What stops bookings from syncing to a K-Series location?”
Tell an agent destructive · confirm first
Deactivate platform {platform} for business location {location} and restaurant {restaurant}.
Disconnect restaurant {restaurant} from platform {platform} at location {location}.

Documentation

📖
Documentation
https://x-series-api.lightspeedhq.com/docs/introduction
📖
APIReference
https://x-series-api.lightspeedhq.com/reference
📖
GettingStarted
https://x-series-api.lightspeedhq.com/docs/quick_start
📖
Documentation
https://api-portal.lsk.lightspeed.app/
📖
APIReference
https://api-docs.lsk.lightspeed.app/
📖
GettingStarted
https://api-portal.lsk.lightspeed.app/quick-start/intro

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lightspeed/refs/heads/main/openapi/lightspeed-reservations-for-platforms-api-openapi.yml

Other Resources

🔗
ChangeLog
https://x-series-api.lightspeedhq.com/changelog
🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/lightspeed/refs/heads/main/llms/lightspeed-llms.txt
🔗
SignUp
https://developers.retail.lightspeed.app/register
🔗
ChangeLog
https://api-docs.lsk.lightspeed.app/changes

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/lightspeed:lightspeed-reservations-for-platforms-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

lightspeed-reservations-for-platforms-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 1.0.0
  title: Lightspeed Restaurant K Series Reservations for Platforms…
  description: '**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.

    Detailed developer guides can be found in the Lightspeed Restaurant API Portal.

    These services are in continuous development and subject to change. Please find our versioning policy here.'
  x-logo:
    altText: Lightspeed Commerce
    url: static/lightspeed@2x.png
servers:
- url: https://api.trial.lsk.lightspeed.app
  description: Demo URL
  x-bump-branch-name: demo
- url: https://api.lsk.lightspeed.app
  description: Production URL
  x-bump-branch-name: prod
tags:


# --- truncated at 32 KB (76 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lightspeed/refs/heads/main/openapi/lightspeed-reservations-for-platforms-api-openapi.yml