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

Mar 20, 2024

demo
1.0.0
Compare

API structure has changed

8 structure changes including:
8 Modifications
Modified 8 Breaking
GET /reservation/api/1/platform/{platform-code}/profile
  • Response
  • 200 response Modified
    • application/json content type Modified
      • webhook_url, notification_types, display_name, deposit_supported, own_notifications_only, webhook_auth_type, webhook_auth_details properties Removed

        • Removing a resource is always breaking unless it was deprecated before

          Breaking

      • webhookUrl, notificationTypes, displayName, depositSupported, ownNotificationsOnly, webhookAuthType, webhookAuthDetails properties Added
GET /reservation/api/1/user/platform/{platform-code}/business-locations
  • Response
  • 200 response Modified
    • application/json content type Modified
PATCH /reservation/api/1/platform/{platform-code}/webhook/auth/bearer-auth
  • Body
  • application/json content type Modified
    • token_ttl property Removed

      • Removing a resource is always breaking unless it was deprecated before

        Breaking

    • tokenTtl property Added
PATCH /reservation/api/1/platform/{platform-code}/webhook/auth/oauth2
  • Body
  • application/json content type Modified
    • client_id, client_secret, client_name, client_authorization_method, authorization_grant_type, provider_token_uri, provider_jwk_set_uri properties Removed

      • Removing a resource is always breaking unless it was deprecated before

        Breaking

    • clientId, clientSecret, clientName, clientAuthorizationMethod, authorizationGrantType, providerTokenUri, providerJwkSetUri properties Added
POST /reservation/api/1/platform/{platform-code}/profile
  • Body
  • application/json content type Modified
    • webhook_url, notification_types, display_name, deposit_supported, own_notifications_only, webhook_auth_type, webhook_auth_details properties Removed

      • Removing a resource is always breaking unless it was deprecated before

        Breaking

    • webhookUrl, notificationTypes, displayName, depositSupported, ownNotificationsOnly, webhookAuthType, webhookAuthDetails properties Added
POST /reservation/api/1/user/platform/{platform-code}/integration/activate
  • Body
  • application/json content type Modified
    • business_location_id, platform_restaurant_id properties Removed

      • Removing a resource is always breaking unless it was deprecated before

        Breaking

    • businessLocationId, platformRestaurantId properties Added
POST /reservation/api/1/user/platform/{platform-code}/integration/deactivate
  • Body
  • application/json content type Modified
    • business_location_id, platform_restaurant_id properties Removed

      • Removing a resource is always breaking unless it was deprecated before

        Breaking

    • businessLocationId, platformRestaurantId properties Added
PUT /reservation/api/1/platform/{platform-code}/restaurant/{platform-restaurant}/reservation/{platform-reservation}/push
  • Body
  • application/json content type Modified
    • guest property Modified
      • platform_guest_id, first_name, last_name, walk_in properties Removed

        • Removing a resource is always breaking unless it was deprecated before

          Breaking

      • platformGuestId, firstName, lastName, walkIn properties Added
    • liability property Modified
      • deposits, refunds properties Modified
    • party_size, table_numbers, utc_scheduled_at, utc_updated_at, sequence_id properties Removed

      • Removing a resource is always breaking unless it was deprecated before

        Breaking

    • partySize, tableNumbers, utcScheduledAt, utcUpdatedAt, sequenceId properties Added