Change Updates

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 Breaking
POST /items/v1/items
  • Body
  • application/json content type Modified
    • businessLocationId, accountingGroupId, defaultPrice properties Modified
      • Properties are now required
        Breaking
3 structure changes including:
3 Modifications
Modified 3
POST /o/op/1/order/local
  • Body
  • application/json content type Modified
    • targetPrinterProfileId property Added
POST /o/op/1/order/toGo
  • Body
  • application/json content type Modified
    • targetPrinterProfileId property Added
POST /o/op/1/pay
  • Body
  • application/json content type Modified
    • targetPrinterProfileId property Added
2 structure changes including:
2 Additions
Added 2
POST /id-cards/v1/business-locations/{businessLocationId}/batches
POST /id-cards/v1/business-locations/{businessLocationId}/batches/{batchId}/cards
1 structure change including:
1 Modification
Modified 1
POST reservation-serviceReservation order notificationwebhook
  • Body
  • application/json content type Modified
    • account property Modified
      • id property Modified
        • Property is now deprecated
    • platformReservationId property Added
5 structure changes including:
5 Modifications
Modified 5
DELETE /o/wh/1/webhook/{endpointId}/business-locations/{businessLocationId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • warnings property Added
GET /o/op/1/itemAvailability
  • Response
  • 200 response Modified
    • application/json content type Modified
      • metadata property Modified
        • warnings property Added
GET /o/wh/1/webhook/{endpointId}/business-locations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • warnings property Added
POST /o/op/1/itemAvailability
  • Response
  • 200 response Modified
    • application/json content type Modified
      • metadata property Modified
        • warnings property Added
PUT /o/wh/1/webhook/{endpointId}/business-locations/{businessLocationId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • warnings property Added
10 structure changes including:
10 Breaking changes
10 Modifications
Modified 10 Breaking
POST apeItem availability notificationwebhook
  • Path went from /Item availability notification to /apeItem availability notification (same operationId)
    Breaking
POST apeOrder notificationwebhook
  • Path went from /Order notification to /apeOrder notification (same operationId)
    Breaking
POST apePayment notificationwebhook
  • Path went from /Payment notification to /apePayment notification (same operationId)
    Breaking
POST pms-integration{subscriber-host}/chargewebhook
  • Path went from /{subscriber-host}/charge to /pms-integration{subscriber-host}/charge (same operationId)
    Breaking
POST reservation-servicePOS reservation updated notificationwebhook
  • Path went from /POS reservation updated notification to /reservation-servicePOS reservation updated notification (same operationId)
    Breaking
POST reservation-serviceReservation error notificationwebhook
  • Path went from /Reservation error notification to /reservation-serviceReservation error notification (same operationId)
    Breaking
POST reservation-serviceReservation integration notificationwebhook
  • Path went from /Reservation integration notification to /reservation-serviceReservation integration notification (same operationId)
    Breaking
POST reservation-serviceReservation onboarding notificationwebhook
  • Path went from /Reservation onboarding notification to /reservation-serviceReservation onboarding notification (same operationId)
    Breaking
POST reservation-serviceReservation order notificationwebhook
  • Path went from /Reservation order notification to /reservation-serviceReservation order notification (same operationId)
    Breaking
POST staff-apiShift notificationwebhook
  • Path went from /Shift notification to /staff-apiShift notification (same operationId)
    Breaking
5 structure changes including:
5 Modifications
Modified 5
GET /i/richItem/{businessId}
  • Response
  • 200 response Modified
    • application/hal+json;charset=UTF-8 content type Modified
      • _embedded property Modified
        • richItemDtoList property Modified
GET /i/richItem/{businessId}/{sku}
  • Response
  • 200 response Modified
    • application/hal+json;charset=UTF-8 content type Modified
      • previewPictureUrl property Added
PATCH /i/richItem/{businessId}/{sku}
  • Response
  • 200 response Modified
    • application/hal+json;charset=UTF-8 content type Modified
      • previewPictureUrl property Added
POST /i/richItem/{businessId}/itemsBySkus
  • Response
  • 200 response Modified
    • application/hal+json;charset=UTF-8 content type Modified
      • _embedded property Modified
        • richItemDtoList property Modified
PUT /i/richItem/{businessId}/{sku}
  • Response
  • 200 response Modified
    • application/hal+json;charset=UTF-8 content type Modified
      • previewPictureUrl property Added
5 structure changes including:
4 Breaking changes
1 Addition
4 Modifications
Modified 4 Breaking
POST Reservation error notificationwebhook
  • Path went from /Error notification to /Reservation error notification (same operationId)
    Breaking
POST Reservation integration notificationwebhook
  • Path went from /Integration notification to /Reservation integration notification (same operationId)
    Breaking
POST Reservation onboarding notificationwebhook
  • Path went from /Onboarding notification to /Reservation onboarding notification (same operationId)
    Breaking
POST Reservation order notificationwebhook
  • Path went from /Order notification to /Reservation order notification (same operationId)
    Breaking
Added 1
POST Order notificationwebhook
1 structure change including:
1 Modification
Modified 1
POST Order notificationwebhook
  • Body
  • application/json content type Modified
    • account property Modified
      • orderMode property Added
6 structure changes including:
6 Additions
Added 6
DELETE /o/wh/1/webhook/{endpointId}/business-locations/{businessLocationId}
GET /o/op/1/itemAvailability
GET /o/wh/1/webhook/{endpointId}/business-locations
POST /o/op/1/itemAvailability
PUT /o/wh/1/webhook/{endpointId}/business-locations/{businessLocationId}
POST Item availability notificationwebhook
1 structure change including:
1 Modification
Modified 1
PUT /reservation/api/1/platform/{platform-code}/restaurant/{platform-restaurant-id}/reservation/{platform-reservation-id}/push
  • Body
  • application/json content type Modified
    • guestRequest, expectedDuration properties Added
5 structure changes including:
5 Modifications
Modified 5
GET /f/finance/{businessLocationId}/dailyFinancials
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sales property Modified
        • salesLines property Modified
GET /f/finance/{businessLocationId}/financials/{from}/{to}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sales property Modified
        • salesLines property Modified
GET /f/finance/{businessLocationId}/saleByExternalReference
  • Response
  • 200 response Modified
    • application/json content type Modified
      • salesLines property Modified
        • serviceChargeType property Added
GET /f/v2/business-location/{businessLocationId}/sales
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sales property Modified
        • salesLines property Modified
GET /f/v2/business-location/{businessLocationId}/sales-daily
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sales property Modified
        • salesLines property Modified
1 structure change including:
1 Addition
Added 1
DELETE /o/wh/1/webhook/{endpointId}
1 structure change including:
1 Breaking change
1 Removal
Removed 1 Breaking
POST /items/v2/business-locations/{businessLocationId}/menus/suggestions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
1 structure change including:
1 Addition
Added 1
POST /items/v2/business-locations/{businessLocationId}/menus/suggestions
5 structure changes including:
5 Modifications
Modified 5
GET /f/finance/{businessLocationId}/dailyFinancials
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sales property Modified
        • salesLines property Modified
GET /f/finance/{businessLocationId}/financials/{from}/{to}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sales property Modified
        • salesLines property Modified
GET /f/finance/{businessLocationId}/saleByExternalReference
  • Response
  • 200 response Modified
    • application/json content type Modified
      • salesLines property Modified
        • accountDiscountType, accountDiscountCode, accountDiscountName properties Added
GET /f/v2/business-location/{businessLocationId}/sales
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sales property Modified
        • salesLines property Modified
GET /f/v2/business-location/{businessLocationId}/sales-daily
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sales property Modified
        • salesLines property Modified
1 structure change including:
1 Addition
Added 1
POST POS reservation updated notificationwebhook
5 structure changes including:
5 Modifications
Modified 5
GET /f/finance/{businessLocationId}/dailyFinancials
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sales property Modified
        • salesLines property Modified
GET /f/finance/{businessLocationId}/financials/{from}/{to}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sales property Modified
        • salesLines property Modified
GET /f/finance/{businessLocationId}/saleByExternalReference
  • Response
  • 200 response Modified
    • application/json content type Modified
      • salesLines property Modified
        • nameOverride property Added
GET /f/v2/business-location/{businessLocationId}/sales
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sales property Modified
        • salesLines property Modified
GET /f/v2/business-location/{businessLocationId}/sales-daily
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sales property Modified
        • salesLines property Modified
1 structure change including:
1 Addition
Added 1
POST {subscriber-host}/chargewebhook
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
      • posReservationUpdateWebhookUrl, allowedPosStatuses properties Added
POST /reservation/api/1/platform/{platform-code}/profile
  • Body
  • application/json content type Modified
    • posReservationUpdateWebhookUrl, allowedPosStatuses properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • posReservationUpdateWebhookUrl, allowedPosStatuses properties Added