Lightspeed Restaurant K-Series API documentation

3 days ago

Change #b0a5f6a8

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 attribute Modified

5 days ago

Change #f8df7279

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 attribute Modified

9 days ago

Change #949142aa

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

9 days ago

Change #6c48db97

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 attribute Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - epochSecondsDeadlineUtc attribute Added

Added 1

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

9 days ago

Change #f98bcb5b

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}

20 days ago

Change #594a20e9

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

25 days ago

Change #68113107

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 attribute Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - baseUrl, orderWebhookUrl, integrationWebhookUrl, onboardingWebhookUrl, errorsWebhookUrl attributes Added

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

Body
application/json content type Modified
- webhookUrl attribute Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- baseUrl, orderWebhookUrl, integrationWebhookUrl, onboardingWebhookUrl, errorsWebhookUrl attributes 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

27 days ago

Change #d2e7943f

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 attribute Modified

Apr 12, 2024

Change #64cd2a3c

1.0.0

Breaking

Compare

2 structure changes including:

2 Modifications

Modified 2 Breaking

GET /f/finance/{businessLocationId}/dailyFinancials

Response
200 response Modified
- application/json content type Modified
  - businessName attribute Modified
    - Name went from businessname to businessName
      Breaking

GET /f/finance/{businessLocationId}/financials/{from}/{to}

Response
200 response Modified
- application/json content type Modified
  - businessName attribute Modified
    - Name went from businessname to businessName
      Breaking

Apr 12, 2024

Change #46dbd60f

1.0.0

Compare

1 structure change including:

1 Modification

Modified 1

GET /o/op/1/order/accounts/{accountIdentifier}

Response
400 response Added

Apr 11, 2024

Change #feb654b6

1.0.0

Compare

1 structure change including:

1 Addition

Added 1

GET /f/v2/beta/business-location/{businessLocationId}/aborted-orders

Apr 5, 2024

Change #1b20b36d

1.0.0

Breaking

Compare

2 structure changes including:

1 Breaking change

1 Addition

1 Removal

Removed 1 Breaking

GET /reservation/api/1/platform/webhook-demo

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

Added 1

DELETE /i/richItem/{businessId}/{sku}

Mar 28, 2024

Change #54ee49eb

1.0.0

Breaking

Compare

1 structure change including:

1 Modification

Modified 1

GET /reservation/api/1/platform/webhook-demo

Response
200 response Modified
- */* content type Modified
  - account attribute Modified

Mar 26, 2024

Change #f3598088

1.0.0

Compare

1 structure change including:

1 Addition

Added 1

GET /reservation/api/1/platform/webhook-demo

Mar 26, 2024

Change #7867075f

1.0.0

Breaking

Compare

1 structure change including:

1 Breaking change

1 Removal

Removed 1 Breaking

GET /f/v2/business-location/{businessLocationId}/lightspeed-payments

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

Mar 25, 2024

Change #3fce286b

1.0.0

Compare

1 structure change including:

1 Addition

Added 1

GET /f/v2/business-location/{businessLocationId}/lightspeed-payments

Mar 20, 2024

Change #b6e02364

1.0.0

Breaking

Compare

8 structure changes including:

8 Modifications

Modified 8 Breaking

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

Response
200 response Modified
- application/json content type Modified
  - webhook_url, notification_types, display_name, deposit_supported, own_notifications_only, webhook_auth_type, webhook_auth_details attributes Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - webhookUrl, notificationTypes, displayName, depositSupported, ownNotificationsOnly, webhookAuthType, webhookAuthDetails attributes Added

GET /reservation/api/1/user/platform/{platform-code}/business-locations

Response
200 response Modified
- application/json content type Modified

PATCH /reservation/api/1/platform/{platform-code}/webhook/auth/bearer-auth

Body
application/json content type Modified
- token_ttl attribute Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- tokenTtl attribute Added

PATCH /reservation/api/1/platform/{platform-code}/webhook/auth/oauth2

Body
application/json content type Modified
- client_id, client_secret, client_name, client_authorization_method, authorization_grant_type, provider_token_uri, provider_jwk_set_uri attributes Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- clientId, clientSecret, clientName, clientAuthorizationMethod, authorizationGrantType, providerTokenUri, providerJwkSetUri attributes Added

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

Body
application/json content type Modified
- webhook_url, notification_types, display_name, deposit_supported, own_notifications_only, webhook_auth_type, webhook_auth_details attributes Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- webhookUrl, notificationTypes, displayName, depositSupported, ownNotificationsOnly, webhookAuthType, webhookAuthDetails attributes Added

POST /reservation/api/1/user/platform/{platform-code}/integration/activate

Body
application/json content type Modified
- business_location_id, platform_restaurant_id attributes Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- businessLocationId, platformRestaurantId attributes Added

POST /reservation/api/1/user/platform/{platform-code}/integration/deactivate

Body
application/json content type Modified
- business_location_id, platform_restaurant_id attributes Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- businessLocationId, platformRestaurantId attributes Added

PUT /reservation/api/1/platform/{platform-code}/restaurant/{platform-restaurant}/reservation/{platform-reservation}/push

Body
application/json content type Modified
- guest attribute Modified
  - platform_guest_id, first_name, last_name, walk_in properties Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - platformGuestId, firstName, lastName, walkIn properties Added
- liability attribute Modified
  - deposits, refunds properties Modified
- party_size, table_numbers, utc_scheduled_at, utc_updated_at, sequence_id attributes Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- partySize, tableNumbers, utcScheduledAt, utcUpdatedAt, sequenceId attributes Added

Mar 13, 2024

Change #db9466bb

1.0.0

Compare

2 structure changes including:

2 Additions

Added 2

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

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

Mar 5, 2024

Change #945946b7

1.0.0

Compare

3 structure changes including:

1 Addition

2 Modifications

Modified 2

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

Response
200 response Modified
- application/json content type Modified
  - display_name attribute Added

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

Body
application/json content type Modified
- display_name attribute Added

Added 1

GET /reservation/api/1/user/platform/{platform-code}/business-locations

Feb 19, 2024

Change #d32860ec

1.0.0

Compare

2 structure changes including:

2 Modifications

Modified 2

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

Response
200 response Modified
- application/json content type Modified
  - own_notifications_only attribute Added

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

Body
application/json content type Modified
- own_notifications_only attribute Added

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