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

4 days ago

demo
1.0.0
Compare

API structure has changed

Next Change
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