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
Lightspeed Restaurant K-Series API documentation

Changelog

Last update:
Compare
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
1 structure change including:
1 Breaking change
1 Removal
Removed 1 Breaking
GET /f/v2/business-location/{businessLocationId}/lightspeed-payments
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
1 structure change including:
1 Addition
Added 1
GET /f/v2/business-location/{businessLocationId}/lightspeed-payments
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 attributes Removed

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

          Breaking

      • webhookUrl, notificationTypes, displayName, depositSupported, ownNotificationsOnly, webhookAuthType, webhookAuthDetails attributes 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 attribute Removed

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

        Breaking

    • tokenTtl attribute 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 attributes Removed

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

        Breaking

    • clientId, clientSecret, clientName, clientAuthorizationMethod, authorizationGrantType, providerTokenUri, providerJwkSetUri attributes 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 attributes Removed

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

        Breaking

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

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

        Breaking

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

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

        Breaking

    • businessLocationId, platformRestaurantId attributes Added
PUT /reservation/api/1/platform/{platform-code}/restaurant/{platform-restaurant}/reservation/{platform-reservation}/push
  • Body
  • application/json content type Modified
    • guest attribute 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 attribute Modified
      • deposits, refunds properties Modified
    • party_size, table_numbers, utc_scheduled_at, utc_updated_at, sequence_id attributes Removed

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

        Breaking

    • partySize, tableNumbers, utcScheduledAt, utcUpdatedAt, sequenceId attributes Added
2 structure changes including:
2 Additions
Added 2
GET /f/v2/business-location/{businessLocationId}/sales
GET /f/v2/business-location/{businessLocationId}/sales-daily
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
      • display_name attribute Added
POST /reservation/api/1/platform/{platform-code}/profile
  • Body
  • application/json content type Modified
    • display_name attribute Added
Added 1
GET /reservation/api/1/user/platform/{platform-code}/business-locations
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
      • own_notifications_only attribute Added
POST /reservation/api/1/platform/{platform-code}/profile
  • Body
  • application/json content type Modified
    • own_notifications_only attribute Added
15 structure changes including:
1 Breaking change
11 Additions
3 Modifications
1 Removal
Modified 3
GET /items/v1/items
  • Response
  • 200 response Modified
    • application/json content type Modified
      • barcodes attribute Added
GET /items/v1/items/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • barcodes attribute Added
POST /items/v1/items
  • Body
  • application/json content type Modified
    • barcodes attribute Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • barcodes attribute Added
Removed 1 Breaking
PUT /items/v1/items/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 11
GET /o/op/1/order/accounts/{accountIdentifier}
GET /reservation/api/1/platform/{platform-code}/profile
PATCH /reservation/api/1/platform/{platform-code}/webhook/auth/api-keys
PATCH /reservation/api/1/platform/{platform-code}/webhook/auth/basic-auth
PATCH /reservation/api/1/platform/{platform-code}/webhook/auth/bearer-auth
PATCH /reservation/api/1/platform/{platform-code}/webhook/auth/oauth2
POST /reservation/api/1/platform/{platform-code}/profile
POST /reservation/api/1/user/platform/{platform-code}/integration/activate
POST /reservation/api/1/user/platform/{platform-code}/integration/deactivate
PUT /items/v1/items/{id}
PUT /reservation/api/1/platform/{platform-code}/restaurant/{platform-restaurant}/reservation/{platform-reservation}/push
3 structure changes including:
3 Modifications
Modified 3
GET /f/finance/{businessLocationId}/dailyFinancials
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sales attribute Modified
GET /f/finance/{businessLocationId}/financials/{from}/{to}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sales attribute Modified
GET /f/finance/{businessLocationId}/saleByExternalReference
  • Response
  • 200 response Modified
    • application/json content type Modified
      • payments attribute Modified
3 structure changes including:
3 Modifications
Modified 3 Breaking
GET /o/op/1/menu/load/{menuId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • menuEntryGroups attribute Modified
POST /items/v1/items
  • Body
  • application/json content type Modified
    • barcode attribute Modified

      • Name went from barCode to barcode

        Breaking

PUT /items/v1/items/{id}
  • Body
  • application/json content type Modified
    • barcode attribute Modified

      • Name went from barCode to barcode

        Breaking

1 structure change including:
1 Modification
Modified 1 Breaking
GET /o/op/1/menu/load/{menuId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • menuEntryGroups attribute Modified
  • 400, 403, 404 responses Removed

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

      Breaking

11 structure changes including:
11 Modifications
Modified 11 Breaking
GET /o/op/1/order/table/getCheck
  • Response
  • 400 response Modified
    • */* content type Removed

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

        Breaking

    • application/json content type Added
GET /o/op/1/order/table/{tableNumber}/getCheck
  • Response
  • 400 response Removed

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

      Breaking

  • 404 response Added
GET /o/op/data/businesses
  • Response
  • 404 response Removed

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

      Breaking

GET /o/op/data/{businessLocationId}/floorplans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tables attribute Modified
      • id attribute Added
  • 404 response Modified
    • */* content type Removed

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

        Breaking

GET /o/wh/1/webhook/{endpointId}
  • Response
  • 400 response Removed

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

      Breaking

  • 404 response Added
POST /o/op/1/order/local
  • Body
  • application/json content type Modified
    • items attribute Modified
  • Response
  • 200 response Modified
    • application/json content type Added
  • 400 response Modified
    • */* content type Removed

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

        Breaking

    • application/json content type Added
  • 409 response Added
POST /o/op/1/order/toGo
  • Body
  • application/json content type Modified
    • items attribute Modified
  • Response
  • 200 response Modified
    • application/json content type Added
  • 400 response Modified
    • */* content type Removed

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

        Breaking

    • application/json content type Added
  • 409 response Added
POST /o/op/1/pay
  • Body
  • application/json content type Modified
    • iKaccountId attribute Modified

      • Attribute is now deprecated

  • Response
  • 200 response Modified
    • application/json content type Added
  • 400 response Modified
    • */* content type Modified
      • status attribute Modified

        • Type went from string to integer

          Breaking

      • apiSubExceptions attribute Removed

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

          Breaking

      • error, path attributes Added
POST /o/op/1/printMsg
  • Response
  • 200 response Modified
    • application/json content type Added
POST /o/wh/1/webhook
  • Response
  • 400 response Modified
    • */* content type Removed

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

        Breaking

    • application/json content type Added
PUT /o/wh/1/webhook
  • Response
  • 400 response Modified
    • */* content type Removed

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

        Breaking

    • application/json content type Added