Lightspeed Restaurant K-Series API documentation

Sep 6, 2024

Change #2fce0176

1.0.0

Compare

1 structure change including:

1 Addition

Added 1

Webhook POST Charge Transaction

Sep 3, 2024

Change #b3ccda24

1.0.0

Compare

1 structure change including:

1 Addition

Added 1

GET /staff/v1/businessLocations/{businessLocationId}/shift

Aug 21, 2024

Change #0035b692

1.0.0

Breaking

Compare

1 structure change including:

1 Breaking change

1 Removal

Removed 1 Breaking

GET /staff/v1/businessLocations/{businessLocationId}/shift

Removing a resource is always breaking unless it was deprecated before
Breaking

Aug 14, 2024

Change #8f474235

1.0.0

Breaking

Compare

4 structure changes including:

4 Modifications

Modified 4 Breaking

GET /items/v1/items

Response
200 response Modified
- application/json content type Modified
  - coursingOptions, productionInstructions properties Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

GET /items/v1/items/{id}

Response
200 response Modified
- application/json content type Modified
  - coursingOptions, productionInstructions properties Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

POST /items/v1/items

Body
application/json content type Modified
- businessLocationId property Modified
  - Property is no longer required
  - businessLocationId property Modified
    - Property is no longer required
- accountingGroupId property Modified
  - Property is no longer required
  - accountingGroupId property Modified
    - Property is no longer required
Response
201 response Modified
- application/json content type Modified
  - coursingOptions, productionInstructions properties Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

PUT /items/v1/items/{id}

Response
200 response Modified
- application/json content type Modified
  - coursingOptions, productionInstructions properties Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

Aug 13, 2024

Change #0a502b99

1.0.0

Breaking

Compare

12 structure changes including:

6 Breaking changes

6 Additions

6 Removals

Removed 6 Breaking

DELETE /staff/v1/businessLocations/{businessLocationId}/webhooks/{webhookId}

Removing a resource is always breaking unless it was deprecated before
Breaking

GET /staff/v1/businessLocations/{businessLocationId}/shift

Removing a resource is always breaking unless it was deprecated before
Breaking

GET /staff/v1/businessLocations/{businessLocationId}/webhooks

Removing a resource is always breaking unless it was deprecated before
Breaking

PATCH /staff/v1/businessLocations/{businessLocationId}/webhooks/{webhookId}

Removing a resource is always breaking unless it was deprecated before
Breaking

POST /staff/v1/businessLocations/{businessLocationId}/webhooks

Removing a resource is always breaking unless it was deprecated before
Breaking

Webhook POST Shift notification

Removing a resource is always breaking unless it was deprecated before
Breaking

Added 6

DELETE /staff/v1/businessLocations/{businessLocationId}/webhooks/{webhookId}

GET /staff/v1/businessLocations/{businessLocationId}/shift

GET /staff/v1/businessLocations/{businessLocationId}/webhooks

PATCH /staff/v1/businessLocations/{businessLocationId}/webhooks/{webhookId}

POST /staff/v1/businessLocations/{businessLocationId}/webhooks

Webhook POST Shift notification

Aug 12, 2024

Change #6ba85965

1.0.0

Breaking

Compare

8 structure changes including:

6 Additions

2 Modifications

Modified 2 Breaking

GET /f/finance/{businessLocationId}/tax-rates

Response
200 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added

GET /o/op/data/{businessLocationId}/floorplans

Query
expandTables query parameter Added

Added 6

DELETE /staff/v1/businessLocations/{businessLocationId}/webhooks/{webhookId}

GET /o/op/data/{businessLocationId}/account-profiles/tagcode/{tagCode}

GET /staff/v1/businessLocations/{businessLocationId}/webhooks

PATCH /staff/v1/businessLocations/{businessLocationId}/webhooks/{webhookId}

POST /staff/v1/businessLocations/{businessLocationId}/webhooks

Webhook POST Shift notification

Jun 27, 2024

Change #5200d96e

1.0.0

Compare

4 structure changes including:

4 Modifications

Modified 4

GET /items/v1/items

Response
200 response Modified
- application/json content type Modified
  - coursingOptions, productionInstructions properties Added

GET /items/v1/items/{id}

Response
200 response Modified
- application/json content type Modified
  - coursingOptions, productionInstructions properties Added

POST /items/v1/items

Response
201 response Modified
- application/json content type Modified
  - coursingOptions, productionInstructions properties Added

PUT /items/v1/items/{id}

Response
200 response Modified
- application/json content type Modified
  - coursingOptions, productionInstructions properties Added

Jun 26, 2024

Change #9e3d52ec

1.0.0

Compare

1 structure change including:

1 Modification

Modified 1

GET /f/v2/business-location/{businessLocationId}/sales

Query
to query parameter Modified
- Query parameter is no longer required

Jun 24, 2024

Change #d199a2a7

1.0.0

Compare

1 structure change including:

1 Modification

Modified 1

GET /reservation/api/1/platform/{platform-code}/order-webhook-sample

Response
200 response Modified
- application/json content type Modified
  - account property Modified

Jun 19, 2024

Change #6cdce37a

1.0.0

Compare

1 structure change including:

1 Modification

Modified 1

GET /o/op/1/menu/load/{menuId}

Response
200 response Modified
- application/json content type Modified
  - menuEntryGroups property Modified

Jun 13, 2024

Change #32da736e

1.0.0

Compare

1 structure change including:

1 Addition

Added 1

GET /o/op/data/{businessLocationId}/floorplans/{floorPlanId}/tables

Jun 11, 2024

Change #1401c0dc

1.0.0

Compare

4 structure changes including:

4 Additions

Added 4

GET /staff/v1/businessLocations/{businessLocationId}/shift

GET /staff/v1/businessLocations/{businessLocationId}/staff/{staffId}

GET /staff/v1/businessLocations/{businessLocationId}/userTypes/BACK_OFFICE

GET /staff/v1/businessLocations/{businessLocationId}/userTypes/POS

May 16, 2024

Change #25e580d6

1.0.0

Compare

1 structure change including:

1 Modification

Modified 1

GET /o/op/1/menu/load/{menuId}

Response
200 response Modified
- application/json content type Modified
  - menuEntryGroups property Modified

May 14, 2024

Change #a2c24dd2

1.0.0

Compare

1 structure change including:

1 Modification

Modified 1

GET /o/op/1/menu/load/{menuId}

Response
200 response Modified
- application/json content type Modified
  - menuEntryGroups property Modified

May 10, 2024

Change #c4664fec

1.0.0

Breaking

Compare

3 structure changes including:

3 Breaking changes

3 Removals

Removed 3 Breaking

GET /api/v1/businessLocations/{businessLocationId}/shift

Removing a resource is always breaking unless it was deprecated before
Breaking

GET /api/v1/businessLocations/{businessLocationId}/staff/{staffId}

Removing a resource is always breaking unless it was deprecated before
Breaking

GET /api/v1/businessLocations/{businessLocationId}/userTypes/{userType}

Removing a resource is always breaking unless it was deprecated before
Breaking

May 10, 2024

Change #92a74e0d

1.0.0

Breaking

Compare

2 structure changes including:

1 Addition

1 Modification

Modified 1 Breaking

GET /reservation/api/1/platform/{platform-code}/onboarding-webhook-sample

Response
200 response Modified
- application/json content type Modified
  - epochDeadlineUtc property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - epochSecondsDeadlineUtc property Added

Added 1

POST /reservation/api/1/platform/{platform-code}/integration/onboarding

May 10, 2024

Change #55ae6308

1.0.0

Compare

3 structure changes including:

3 Additions

Added 3

GET /api/v1/businessLocations/{businessLocationId}/shift

GET /api/v1/businessLocations/{businessLocationId}/staff/{staffId}

GET /api/v1/businessLocations/{businessLocationId}/userTypes/{userType}

Apr 29, 2024

Change #5567c2f0

1.0.0

Breaking

Compare

4 structure changes including:

4 Breaking changes

4 Modifications

Modified 4 Breaking

GET /reservation/api/1/platform/{platform-code}/error-webhook-sample

Path went from `/reservation/api/1/platform/error-webhook-sample` to `/reservation/api/1/platform/{platform-code}/error-webhook-sample` (same operationId)
Breaking
Path
platform-code path parameter Added
Authentication
OAuth2 authentication method Added

GET /reservation/api/1/platform/{platform-code}/integration-webhook-sample

Path went from `/reservation/api/1/platform/integration-webhook-sample` to `/reservation/api/1/platform/{platform-code}/integration-webhook-sample` (same operationId)
Breaking
Path
platform-code path parameter Added
Authentication
OAuth2 authentication method Added

GET /reservation/api/1/platform/{platform-code}/onboarding-webhook-sample

Path went from `/reservation/api/1/platform/onboarding-webhook-sample` to `/reservation/api/1/platform/{platform-code}/onboarding-webhook-sample` (same operationId)
Breaking
Path
platform-code path parameter Added
Authentication
OAuth2 authentication method Added

GET /reservation/api/1/platform/{platform-code}/order-webhook-sample

Path went from `/reservation/api/1/platform/order-webhook-sample` to `/reservation/api/1/platform/{platform-code}/order-webhook-sample` (same operationId)
Breaking
Path
platform-code path parameter Added
Authentication
OAuth2 authentication method Added

Apr 24, 2024

Change #631e620e

1.0.0

Breaking

Compare

6 structure changes including:

4 Additions

2 Modifications

Modified 2 Breaking

GET /reservation/api/1/platform/{platform-code}/profile

Response
200 response Modified
- application/json content type Modified
  - webhookUrl property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - baseUrl, orderWebhookUrl, integrationWebhookUrl, onboardingWebhookUrl, errorsWebhookUrl properties Added

POST /reservation/api/1/platform/{platform-code}/profile

Body
application/json content type Modified
- webhookUrl property Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- baseUrl, orderWebhookUrl, integrationWebhookUrl, onboardingWebhookUrl, errorsWebhookUrl properties Added

Added 4

GET /reservation/api/1/platform/error-webhook-sample

GET /reservation/api/1/platform/integration-webhook-sample

GET /reservation/api/1/platform/onboarding-webhook-sample

GET /reservation/api/1/platform/order-webhook-sample

Apr 22, 2024

Change #16509b27

1.0.0

Breaking

Compare

1 structure change including:

1 Modification

Modified 1

GET /i/richItem/{businessId}/pictureSpec

Response
200 response Modified
- application/hal+json;charset=UTF-8 content type Modified
  - _links property Modified

Do not miss any Lightspeed Restaurant K-Series API changes, ever again

Changelog

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed