How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Lightspeed Commerce Reservations for Platforms API

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

Lightspeed Commerce Reservations for Platforms API is one of 58 APIs that Lightspeed Commerce publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Reservations for Platforms. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and a changelog.

This API exposes 12 operations across 11 paths, and defines 46 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.trial.lsk.lightspeed.app, https://api.lsk.lightspeed.app.

12 operations 11 paths 46 schemas 2 GET5 PATCH4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://{domain_prefix}.retail.lightspeed.app
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Lightspeed Commerce Reservations for Platforms API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 8 scopes.

  • OAuth2 — The Lightspeed Restaurant K-Series APIs support OAuth2 authentication using the [authorization code grant flow](https://www.oauth.com/oauth2-servers/server-sid…

Paths & Operations 12

Across 11 paths, the API surfaces 12 operations — 2 GET, 5 PATCH, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Reservations for Platforms 12
POST
/reservation/api/1/platform/{platform-code}/integration/onboarding
Callback to Complete Onboarding
reservation-serviceOnboardingCallback 1 param body → 200400403404
GET
/reservation/api/1/platform/{platform-code}/profile
Platform Profile Details
reservation-serviceGetByPlatformCode 1 param → 200400403
POST
/reservation/api/1/platform/{platform-code}/profile
Create or Update Platform Profile
reservation-serviceSetByPlatformCode 1 param body → 200400403
PATCH
/reservation/api/1/platform/{platform-code}/course-settings
Platform course settings definition
reservation-servicePlatformCourseSettings 1 param body → 200400403
PUT
/reservation/api/1/platform/{platform-code}/restaurant/{platform-restaurant-id}/reservation/{platform-reservation-id}/push
Create or Update Reservation
reservation-servicePushPlatformReservation 3 params body → 202400403404
PATCH
/reservation/api/1/platform/{platform-code}/webhook/auth/api-keys
Add authentication by XApiKey
reservation-serviceActivateApiKeysAuth 1 param body → 200400403404
PATCH
/reservation/api/1/platform/{platform-code}/webhook/auth/basic-auth
Add authentication with BasicAuth
reservation-serviceActivateBasicAuth 1 param body → 200400403404
PATCH
/reservation/api/1/platform/{platform-code}/webhook/auth/bearer-auth
Add authentication with BearerAuth
reservation-serviceActivateBearerAuthAuth 1 param body → 200400403404
PATCH
/reservation/api/1/platform/{platform-code}/webhook/auth/oauth2
Add authentication with OAuth2
reservation-serviceActivateOAuth2 1 param body → 200400403404
GET
/reservation/api/1/user/platform/{platform-code}/business-locations
Get Business Locations
reservation-serviceGetBusinessLocations 3 params → 200400403404
POST
/reservation/api/1/user/platform/{platform-code}/integration/activate
Activate Integration for Restaurant
reservation-serviceActivatePlatformIntegration 1 param body → 200400403404
POST
/reservation/api/1/user/platform/{platform-code}/integration/deactivate
Deactivate Integration for Restaurant
reservation-serviceDeactivatePlatformIntegration 1 param body → 200400403404

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are reservation-serviceAccount (38 properties), reservation-serviceTransactionLine (21 properties), reservation-servicePlatformProfile (15 properties), reservation-servicePlatformProfileResponse (14 properties). Each schema is shown below with its type and property counts.

reservation-serviceAccount
object
38 properties
reservation-serviceIntegrationWebhook
object
4 properties 4 required
reservation-servicePaymentLine
object
8 properties
reservation-serviceErrorCode
string
A code that describes the reason for the error.
reservation-servicePlatformCourseSettingsDto
object
2 properties
reservation-serviceBusinessLocationId
integer
The unique identifier of the business location.
reservation-servicePlatformReservation
object
13 properties 5 required
reservation-serviceTransactionLine
object
21 properties
reservation-serviceOnboardingWebhook
object
5 properties 5 required
reservation-serviceExternalConsumerRecord
object
The external reservation system's unique identifier for the consumer.
2 properties
reservation-serviceContactInfo
object
7 properties
reservation-serviceOrderUpdate
object
7 properties
reservation-serviceOnboardingCode
string
The machine code to interact with the external platform during the onboarding process.
reservation-servicePlatformWebhookResponseDto
object
Updated webhook authorization details.
2 properties 2 required
reservation-servicePlatformReservationId
string
The external platform's unique identifier for the reservation.
reservation-serviceDiscount
object
5 properties
reservation-serviceOnboardingCallbackResponse
object
1 property 1 required
reservation-servicePlatformDisplayName
string
The official platform name that will be displayed.
reservation-serviceConsumer
object
2 properties
reservation-serviceConsumerRecord
object
5 properties
reservation-servicePosReservationUpdate
object
7 properties
reservation-servicePlatformRestaurantReference
string
The alias for a restaurant on an external platform, such as its unique identifier or local unique name.
reservation-servicePlatformCode
string
The unique code assigned to the reservation platform.
reservation-servicePlatformProfileResponse
object
14 properties 2 required
reservation-servicePlatformBearerTokenWebhook
object
The bearer token that will be sent with the webhook notifications. See [Bearer Authentication](https://swagger.io/docs/specification/authentication/bearer-auth…
2 properties 1 required
reservation-serviceLiability
object
The guest's obligation for the reservation.
3 properties 2 required
reservation-servicePlatformBasicAuthWebhook
object
The basic authentication credentials that will be sent with the webhook notifications. See [Basic Authentication](https://swagger.io/docs/specification/authent…
2 properties 2 required
reservation-servicePlatformTableStatusDto
object
3 properties 3 required
reservation-servicePlatformRestaurantId
string
The external platform's unique identifier for the restaurant.
reservation-serviceModifier
object
A production instruction entered for a line.
2 properties
reservation-servicePlatformIntegrationDto
object
2 properties 2 required
reservation-servicePlatformProfile
object
15 properties 3 required
reservation-serviceExternalReference
object
The unique identifier of this transaction provided by 3rd parties or the K-Series backend.
2 properties
reservation-serviceTax
object
4 properties
reservation-serviceCategory
object
A list of the reporting categories in which the sale is to be aggregated.
2 properties
reservation-servicePlatformAPIKeysWebhook
object
The API keys that will be sent with the webhook notifications. See [API Keys](https://swagger.io/docs/specification/authentication/api-keys/).
2 properties
reservation-serviceStatus
string
Extended Lightspeed reservation statuses.
reservation-serviceOnboardingCallbackRequest
object
4 properties 4 required
reservation-servicePlatformReservationStatus
string
External reservation statuses for platforms.
reservation-servicePlatformBusinessLocation
object
8 properties 1 required
reservation-servicePlatformDepositSupported
boolean
Whether or not the platform supports deposits.
reservation-serviceOnboardingId
string
The unique identifier of the integration process that has started onboarding.
reservation-serviceErrorWebhook
object
9 properties 5 required
reservation-servicePlatformOAuth2Webhook
object
The OAuth2 credentials that will be sent with the webhook notifications. See [OAuth 2.0](https://oauth.net/2/).
8 properties 3 required
reservation-serviceEntityType
string
The type of entity with which the error occurred.
reservation-servicePlatformReservationAcceptedDto
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightspeed-reservations-for-platforms-api-openapi.yml Raw ↑

Other APIs Lightspeed Commerce publishes across the network.

Lightspeed Retail R-Series API
Lightspeed eCom API
Lightspeed eCom E-Series (Ecwid) API
Lightspeed Restaurant O-Series (Kounta) API
Lightspeed Golf (Chronogolf) Partner API
Lightspeed Commerce Audit API
Lightspeed Commerce Brands API
Lightspeed Commerce Channel Request Log API
Lightspeed Commerce Consignment Products API
Lightspeed Commerce Consignments API
Lightspeed Commerce Customer Addresses API
Lightspeed Commerce Customer Groups API
Where this information came from

This is an independent, third-party profile of Lightspeed Commerce Reservations for Platforms API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.