Lightspeed Restaurant K-Series API documentation

Changelog

Last update:
Compare

API structure has changed

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

API structure has changed

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

API structure has changed

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

API structure has changed

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

API structure has changed

Modified 3
GET /o/op/1/order/table/getCheck
  • Response
  • 200 response Modified
    • application/json content type Modified
      • deviceId, id, identifier, number attributes Modified

        • Attributes are now deprecated

      • salesEntries attribute Modified
GET /o/op/1/order/table/{tableNumber}/getCheck
  • Response
  • 200 response Modified
    • application/json content type Modified
      • deviceId, id, identifier, number attributes Modified

        • Attributes are now deprecated

      • salesEntries attribute Modified
Webhook POST Order notification
  • Body
  • application/json content type Modified
    • account attribute Modified

API structure has changed

Modified 1
GET /f/data/businesses
  • Query
  • page, size query parameters Added

API structure has changed

Modified 2
GET /f/finance/{businessLocationId}/dailyFinancials
  • Response
  • 200 response Modified
    • _links attribute Modified
GET /f/finance/{businessLocationId}/financials/{from}/{to}
  • Response
  • 200 response Modified
    • _links attribute Modified

API structure has changed

Removed 2 Breaking
GET /pms/v1/business-locations/{businessLocationId}/parameters
PATCH /pms/v1/business-locations/{businessLocationId}/parameters

API structure has changed

Added 2
GET /pms/v1/business-locations/{businessLocationId}/parameters
PATCH /pms/v1/business-locations/{businessLocationId}/parameters

API structure has changed

Modified 3
GET /f/finance/{businessLocationId}/dailyFinancials
  • Response
  • 200 response Modified
    • sales attribute Modified
GET /f/finance/{businessLocationId}/financials/{from}/{to}
  • Response
  • 200 response Modified
    • sales attribute Modified
GET /f/finance/{businessLocationId}/saleByExternalReference
  • Response
  • 200 response Modified
    • salesLines attribute Modified

API structure has changed

Modified 3
GET /f/finance/{businessLocationId}/dailyFinancials
  • Response
  • 200 response Modified
    • sales attribute Modified
GET /f/finance/{businessLocationId}/financials/{from}/{to}
  • Response
  • 200 response Modified
    • sales attribute Modified
GET /f/finance/{businessLocationId}/saleByExternalReference
  • Response
  • 200 response Modified
    • salesLines attribute Modified

API structure has changed

Modified 3
GET /f/finance/{businessLocationId}/dailyFinancials
  • Response
  • 200 response Modified
    • sales attribute Modified
GET /f/finance/{businessLocationId}/financials/{from}/{to}
  • Response
  • 200 response Modified
    • sales attribute Modified
GET /f/finance/{businessLocationId}/saleByExternalReference
  • Response
  • 200 response Modified
    • payments attribute Modified

API structure has changed

Modified 2 Breaking
POST /r/2/reservations
  • Body
  • content type Modified
    • customer attribute Modified
POST /r/reservation/1/checkin
  • Body
  • content type Modified
    • customerInfo attribute Modified

API documentation has been created