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
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
1 structure change including:
1 Modification
Modified 1
POST Order notificationwebhook
  • Body
  • application/json content type Modified
    • account property Modified
      • accountObjectId, tableName, tableNumber properties Modified
        • Properties are now deprecated
      • tables property Added
1 structure change including:
1 Breaking change
1 Removal
Removed 1 Breaking
POST {subscriber-host}/chargewebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
6 structure changes including:
6 Modifications
Modified 6 Breaking
DELETE /pms/v1/providers/{id}
  • Response
  • 403 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /pms/v1/business-locations/{businessLocationId}/revenue-centers
  • Response
  • 403 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /pms/v1/providers
  • Response
  • 403 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /pms/v1/providers/{id}
  • Response
  • 403 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /pms/v1/providers
  • Response
  • 403 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PUT /pms/v1/providers/{id}
  • Response
  • 403 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
6 structure changes including:
6 Modifications
Modified 6 Breaking
DELETE /pms/v1/providers/{id}
  • Response
  • 503 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /pms/v1/business-locations/{businessLocationId}/revenue-centers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from object to array[object]
        Breaking
      • id, name properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • object property Added
  • 503 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /pms/v1/providers
  • Query
  • businessLocationId query parameter Modified
    • Query parameter is no longer required
  • Response
  • 503 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /pms/v1/providers/{id}
  • Response
  • 503 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /pms/v1/providers
  • Response
  • 503 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PUT /pms/v1/providers/{id}
  • Response
  • 503 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
12 structure changes including:
12 Modifications
Modified 12 Breaking
GET /reservation/api/1/platform/{platform-code}/profile
  • Response
  • 200 response Modified
    • application/json content type Modified
      • notificationTypes property Modified
        • Type went from array to array[string]
      • webhookAuthDetails property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /reservation/api/1/user/platform/{platform-code}/business-locations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • businessLocationId property Modified
        • Property is now required
          Breaking
        • Type went from integer(int64) to string
          Breaking
PATCH /reservation/api/1/platform/{platform-code}/course-settings
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /reservation/api/1/platform/{platform-code}/webhook/auth/api-keys
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
  • Response
  • 200 response Modified
    • application/json content type Added
PATCH /reservation/api/1/platform/{platform-code}/webhook/auth/basic-auth
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
  • Response
  • 200 response Modified
    • application/json content type Added
PATCH /reservation/api/1/platform/{platform-code}/webhook/auth/bearer-auth
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
    • tokenTtl property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • ttl property Added
  • Response
  • 200 response Modified
    • application/json content type Added
PATCH /reservation/api/1/platform/{platform-code}/webhook/auth/oauth2
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
  • Response
  • 200 response Modified
    • application/json content type Added
POST /reservation/api/1/platform/{platform-code}/integration/onboarding
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
POST /reservation/api/1/platform/{platform-code}/profile
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
    • notificationTypes property Modified
      • Type went from array to array[string]
    • webhookAuthDetails property Modified
      • bearer property Modified
        • tokenTtl property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • ttl property Added
  • Response
  • 200 response Modified
    • application/json content type Added
POST /reservation/api/1/user/platform/{platform-code}/integration/activate
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
POST /reservation/api/1/user/platform/{platform-code}/integration/deactivate
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /reservation/api/1/platform/{platform-code}/restaurant/{platform-restaurant-id}/reservation/{platform-reservation-id}/push
  • Path went from /reservation/api/1/platform/{platform-code}/restaurant/{platform-restaurant}/reservation/{platform-reservation}/push to /reservation/api/1/platform/{platform-code}/restaurant/{platform-restaurant-id}/reservation/{platform-reservation-id}/push (same operationId)
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
  • Response
  • 202 response Modified
    • application/json content type Added
  • Path
  • platform-restaurant, platform-reservation path parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • platform-restaurant-id, platform-reservation-id path parameters Added
9 structure changes including:
5 Breaking changes
4 Additions
5 Removals
Removed 5 Breaking
GET /reservation/api/1/platform/{platform-code}/error-webhook-sample
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /reservation/api/1/platform/{platform-code}/integration-webhook-sample
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /reservation/api/1/platform/{platform-code}/onboarding-webhook-sample
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /reservation/api/1/platform/{platform-code}/order-webhook-sample
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST Order notificationwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 4
POST Error notificationwebhook
POST Integration notificationwebhook
POST Onboarding notificationwebhook
POST Order notificationwebhook
1 structure change including:
1 Modification
Modified 1
POST /o/op/1/order/toGo
  • Body
  • application/json content type Modified
    • items property Modified
      • discountAmountOverride, discountPercentOverride properties Added
1 structure change including:
1 Modification
Modified 1
POST /o/op/1/order/local
  • Body
  • application/json content type Modified
    • items property Modified
      • discountAmountOverride, discountPercentOverride properties Added
2 structure changes including:
2 Modifications
Modified 2
GET /staff/v1/businessLocations/{businessLocationId}/shift
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • shifts property Modified
POST Shift notificationwebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • events property Modified
        • createdOn property Added
2 structure changes including:
1 Addition
1 Modification
Modified 1
POST /staff/v1/businessLocations/{businessLocationId}/userTypes/POS
  • Body
  • application/json content type Modified
    • visible property Added
Added 1
PUT /staff/v1/businessLocations/{businessLocationId}/userTypes/POS/{staffId}
1 structure change including:
1 Modification
Modified 1 Breaking
POST /o/op/1/order/toGo
  • Body
  • application/json content type Modified
    • takeAway property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
2 structure changes including:
2 Modifications
Modified 2
GET /staff/v1/businessLocations/{businessLocationId}/shift
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • shifts property Modified
POST Shift notificationwebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • declaredCashTips property Added
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
      • allowCourseNumberUpdates, inServiceTableStatuses properties Added
POST /reservation/api/1/platform/{platform-code}/profile
  • Body
  • application/json content type Modified
    • allowCourseNumberUpdates, inServiceTableStatuses properties Added
Added 1
PATCH /reservation/api/1/platform/{platform-code}/course-settings
4 structure changes including:
4 Additions
Added 4
DELETE /staff/v1/businessLocations/{businessLocationId}/unAssignStaff/{staffId}
GET /staff/v1/businessLocations/{businessLocationId}/groups
GET /staff/v1/businessLocations/{businessLocationId}/groups/{groupId}
POST /staff/v1/business/{businessId}/assignStaff/{staffId}
1 structure change including:
1 Modification
Modified 1
PUT /reservation/api/1/platform/{platform-code}/restaurant/{platform-restaurant}/reservation/{platform-reservation}/push
  • Body
  • application/json content type Modified
    • guest property Modified
      • foodAndDrinkNotes, notes, language, allergens, dietaryRestrictions properties Added
    • specialOffer, tags properties Added