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 Order and Pay: Webhook API

The Order and Pay: Webhook API from Lightspeed — 4 operation(s) for order and pay: webhook.

Lightspeed Order and Pay: Webhook API is one of 27 APIs that Lightspeed publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Order and Pay: Webhook. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and code examples.

This API exposes 7 operations across 4 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

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

7 operations 4 paths 5 schemas 2 DELETE2 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://x-series-api.lightspeedhq.com/api/2.0
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Lightspeed Order and Pay: Webhook 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 7

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

Order and Pay: Webhook 7
PUT
/o/wh/1/webhook
Lightspeed Create a Webhook
apeCreateWebhookOo body → 200400
POST
/o/wh/1/webhook
Lightspeed Update a Webhook
apeUpdateWebhookOo body → 200400
GET
/o/wh/1/webhook/{endpointId}
Lightspeed Retrieve a Webhook
apeGetWebhookOo 1 param → 200404
DELETE
/o/wh/1/webhook/{endpointId}
Lightspeed Delete a Webhook
apeDeleteWebhookEndpoint 1 param → 200
GET
/o/wh/1/webhook/{endpointId}/business-locations
Lightspeed Get Webhook Business Locations
apeGetWebhookBusinessLocations 1 param → 200404
PUT
/o/wh/1/webhook/{endpointId}/business-locations/{businessLocationId}
Lightspeed Add a Business Location to a Webhook
apeAddWebhookBusinessLocation 3 params → 200404
DELETE
/o/wh/1/webhook/{endpointId}/business-locations/{businessLocationId}
Lightspeed Remove Business Location from a Webhook
apeRemoveWebhookBusinessLocation 3 params → 200404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are apeWebhookEndpoint (9 properties), apeWebhookEndpointBusinessLocationDto (4 properties), apeEventResource (2 properties), apeCurrentWarning (2 properties). Each schema is shown below with its type and property counts.

apeCurrentWarning
object
2 properties
apeWebhookEndpointBusinessLocationDto
object
4 properties 1 required
apeEventResource
object
Event to listen to by resource
2 properties
apeWebhookEndpoint
object
9 properties 2 required
apeBusinessLocationId
integer
The unique identifier for the business location.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightspeed-pos-order-and-pay-webhook-api-openapi.yml Raw ↑

Other APIs Lightspeed publishes across the network.

Lightspeed eCom C-Series API
Lightspeed eCom E-Series API (Ecwid)
Lightspeed Restaurant L-Series API
Lightspeed Restaurant O-Series API (Kounta)
Lightspeed Restaurant G-Series API (Gastrofix)
Lightspeed ChronoGolf Partner API
Lightspeed Account API
Lightspeed Brands API
Lightspeed Catalog API
Lightspeed Customer API
Lightspeed Customers API
Lightspeed Financial API
Where this information came from

This is an independent, third-party profile of Lightspeed Order and Pay: Webhook 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.