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

Subscribe to the Lightspeed Restaurant K-Series API changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Compare
1 structure change including:
1 Modification
Modified 1
POST /o/op/1/order/local
  • Body
  • application/json content type Modified
    • collectionCode, orderCollectionTimeAsIso8601 properties Added
2 structure changes including:
2 Modifications
Modified 2
GET /f/v2/business-location/{businessLocationId}/sales
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sales property Modified
        • payments property Modified
GET /f/v2/business-location/{businessLocationId}/sales-daily
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sales property Modified
        • payments property Modified
1 structure change including:
1 Modification
Modified 1 Breaking
PUT /i/locales/{businessId}
  • Response
  • 201 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
3 structure changes including:
3 Modifications
Modified 3 Breaking
GET /staff/v1/businessLocations/{businessLocationId}/userTypes/BACK_OFFICE/roles
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from object to array[object]
        Breaking
      • data, links, page properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • staff-apiUserPermission property Added
GET /staff/v1/businessLocations/{businessLocationId}/userTypes/POS/reportAccess
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from object to array[object]
        Breaking
      • data, links, page properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • staff-apiReportAccessLevel property Added
GET /staff/v1/businessLocations/{businessLocationId}/userTypes/POS/roles
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from object to array[object]
        Breaking
      • data, links, page properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • staff-apiUserPermission property Added
6 structure changes including:
6 Breaking changes
6 Removals
Removed 6 Breaking
Bearerauthentication method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /kds-station-service/v1/locations/{locationId}/stations/{kdsId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /kds-station-service/v1/locations/{locationId}/stations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /kds-station-service/v1/locations/{locationId}/stations/{kdsId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /kds-station-service/v1/locations/{locationId}/stations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /kds-station-service/v1/locations/{locationId}/stations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
6 structure changes including:
6 Additions
Added 6
Bearerauthentication method
DELETE /kds-station-service/v1/locations/{locationId}/stations/{kdsId}
GET /kds-station-service/v1/locations/{locationId}/stations
GET /kds-station-service/v1/locations/{locationId}/stations/{kdsId}
POST /kds-station-service/v1/locations/{locationId}/stations
PUT /kds-station-service/v1/locations/{locationId}/stations
2 structure changes including:
2 Modifications
Modified 2
GET /staff/v1/businessLocations/{businessLocationId}/groups
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • staffGroupList property Modified
GET /staff/v1/businessLocations/{businessLocationId}/groups/{groupId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • staffGroup property Modified
2 structure changes including:
2 Additions
Added 2
GET /o/op/1/onlineOrderReadiness
POST apeOnline Ordering API Readiness notificationwebhook
4 structure changes including:
4 Modifications
Modified 4
GET /staff/v1/businessLocations/{businessLocationId}/staff/{staffId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pinLength property Added
GET /staff/v1/businessLocations/{businessLocationId}/userTypes/POS
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • staff property Modified
POST /staff/v1/businessLocations/{businessLocationId}/userTypes/POS
  • Response
  • 201 response Modified
    • application/json content type Modified
      • pinLength property Added
PUT /staff/v1/businessLocations/{businessLocationId}/userTypes/POS/{staffId}
  • Response
  • 201 response Modified
    • application/json content type Modified
      • pinLength property Added
2 structure changes including:
2 Breaking changes
2 Removals
Removed 2 Breaking
DELETE /r/wh/1/webhook/{endpointId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /r/wh/1/webhook/{endpointId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
1 structure change including:
1 Modification
Modified 1
POST apePayment notificationwebhook
  • Body
  • application/json content type Modified
    • errors property Added
1 structure change including:
1 Modification
Modified 1
GET /items/v1/items
  • Query
  • itemIds query parameter Added
4 structure changes including:
1 Addition
3 Modifications
Modified 3
GET /o/op/1/menu/load/{menuId}
  • Operation is now deprecated
POST /o/op/1/order/local
  • Body
  • application/json content type Modified
    • items property Modified
      • subItems property Modified
        • subItems property Added
POST /o/op/1/order/toGo
  • Body
  • application/json content type Modified
    • items property Modified
      • subItems property Modified
Added 1
GET /o/op/2/menu/load/{menuId}
2 structure changes including:
2 Modifications
Modified 2
POST /id-cards/v1/business-locations/{businessLocationId}/batches
  • Authentication
  • O auth2 authentication method Added
POST /id-cards/v1/business-locations/{businessLocationId}/batches/{batchId}/cards
  • Authentication
  • O auth2 authentication method Added
1 structure change including:
1 Modification
Modified 1
POST reservation-serviceReservation order notificationwebhook
  • Body
  • application/json content type Modified
    • platformCode property Added
2 structure changes including:
2 Modifications
Modified 2
GET /f/v2/business-location/{businessLocationId}/sales
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sales property Modified
        • payments property Modified
GET /f/v2/business-location/{businessLocationId}/sales-daily
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sales property Modified
        • payments property Modified
2 structure changes including:
2 Modifications
Modified 2
POST /o/op/1/order/local
  • Body
  • application/json content type Modified
    • customerInfo property Modified
      • sendEmailReceipts property Added
POST /o/op/1/order/toGo
  • Body
  • application/json content type Modified
    • customerInfo property Modified
      • sendEmailReceipts property Added
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
        • menuEntry property Modified
1 structure change including:
1 Addition
Added 1
GET /f/v2/business-location/{businessLocationId}/lightspeed-payments
1 structure change including:
1 Modification
Modified 1
POST reservation-serviceReservation error notificationwebhook
  • Body
  • application/json content type Modified
    • entityType property Added