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
4 structure changes including:
4 Modifications
Modified 4
GET /items/v1/items
  • Response
  • 200 response Modified
    • application/json content type Modified
      • coursingOptions, productionInstructions attributes Added
GET /items/v1/items/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • coursingOptions, productionInstructions attributes Added
POST /items/v1/items
  • Response
  • 201 response Modified
    • application/json content type Modified
      • coursingOptions, productionInstructions attributes Added
PUT /items/v1/items/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • coursingOptions, productionInstructions attributes Added
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

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 attribute Modified
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
1 structure change including:
1 Addition
Added 1
GET /o/op/data/{businessLocationId}/floorplans/{floorPlanId}/tables
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
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
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
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
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
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}
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
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
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
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

1 structure change including:
1 Modification
Modified 1
GET /o/op/1/order/accounts/{accountIdentifier}
  • Response
  • 400 response Added
1 structure change including:
1 Addition
Added 1
GET /f/v2/beta/business-location/{businessLocationId}/aborted-orders
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}
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
1 structure change including:
1 Addition
Added 1
GET /reservation/api/1/platform/webhook-demo