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
2 structure changes including:
2 Modifications
Modified 2
GET /staff/v1/businessLocations/{businessLocationId}/shift
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • shifts property Modified
Webhook POST Shift notification
  • Body
  • application/json content type Modified
    • data property Modified
      • events property Modified
        • createdOn property Added
2 structure changes including:
1 Addition
1 Modification
Modified 1
POST /staff/v1/businessLocations/{businessLocationId}/userTypes/POS
  • Body
  • application/json content type Modified
    • visible property Added
Added 1
PUT /staff/v1/businessLocations/{businessLocationId}/userTypes/POS/{staffId}
1 structure change including:
1 Modification
Modified 1 Breaking
POST /o/op/1/order/toGo
  • Body
  • application/json content type Modified
    • takeAway property Removed

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

        Breaking

2 structure changes including:
2 Modifications
Modified 2
GET /staff/v1/businessLocations/{businessLocationId}/shift
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • shifts property Modified
Webhook POST Shift notification
  • Body
  • application/json content type Modified
    • data property Modified
      • declaredCashTips property Added
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
      • allowCourseNumberUpdates, inServiceTableStatuses properties Added
POST /reservation/api/1/platform/{platform-code}/profile
  • Body
  • application/json content type Modified
    • allowCourseNumberUpdates, inServiceTableStatuses properties Added
Added 1
PATCH /reservation/api/1/platform/{platform-code}/course-settings
4 structure changes including:
4 Additions
Added 4
DELETE /staff/v1/businessLocations/{businessLocationId}/unAssignStaff/{staffId}
GET /staff/v1/businessLocations/{businessLocationId}/groups
GET /staff/v1/businessLocations/{businessLocationId}/groups/{groupId}
POST /staff/v1/business/{businessId}/assignStaff/{staffId}
1 structure change including:
1 Modification
Modified 1
PUT /reservation/api/1/platform/{platform-code}/restaurant/{platform-restaurant}/reservation/{platform-reservation}/push
  • Body
  • application/json content type Modified
    • guest property Modified
      • foodAndDrinkNotes, notes, language, allergens, dietaryRestrictions properties Added
    • specialOffer, tags properties Added
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 property Modified
        • menuEntry property Modified
      • conditionalTaxRules property Added
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 property Modified
        • menuEntry property Modified
5 structure changes including:
4 Additions
1 Modification
Modified 1 Breaking
GET /staff/v1/businessLocations/{businessLocationId}/shift
  • Query
  • startDate, endDate query parameters Removed

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

      Breaking

  • startTime, endTime query parameters Added
Added 4
GET /staff/v1/businessLocations/{businessLocationId}/userTypes/BACK_OFFICE/roles
GET /staff/v1/businessLocations/{businessLocationId}/userTypes/POS/reportAccess
GET /staff/v1/businessLocations/{businessLocationId}/userTypes/POS/roles
POST /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 property Modified
        • menuEntry property 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 property Modified
        • menuEntry property 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 property Modified
        • menuEntry property 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 property Modified
        • menuEntry property Modified
1 structure change including:
1 Breaking change
1 Modification
Modified 1 Breaking
Webhook POST {subscriber-host}/charge
  • Path went from `/Charge Transaction` to `/{subscriber-host}/charge` (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • transactions property Modified
      • quantity property Modified

        • Property is no longer deprecated

      • taxLines property Modified

        • Full types went from object to array[object]

          Breaking

        • taxId, taxName, taxAmount, taxRate, taxIncluded properties Removed

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

            Breaking

        • pms-integrationPmsTaxLineWebhookDto property Added
    • payments property Modified
      • reservationId property Modified

        • Property is no longer deprecated

  • Response
  • 500 response Removed

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

      Breaking

  • 5XX response Added
1 structure change including:
1 Modification
Modified 1 Breaking
Webhook POST Charge Transaction
  • Body
  • application/json content type Modified
    • covers property Modified

      • Full types went from integer to number

        Breaking

    • ownerId property Modified

      • Full types went from string to integer(int64)

        Breaking

1 structure change including:
1 Modification
Modified 1 Breaking
Webhook POST Charge Transaction
  • Body
  • application/json content type Modified
    • deviceId, revenueCenterId properties Modified

      • Full types went from number(int64) to integer(int64)

        Breaking

    • transactions property Modified
      • staffId, groupId properties Modified

        • Full types went from number(int64) to integer(int64)

          Breaking

      • taxId property Modified

        • Full types went from number(int64) to integer(int64)

    • payments property Modified
      • staffId property Modified

        • Full types went from number(int64) to integer(int64)

          Breaking

5 structure changes including:
5 Modifications
Modified 5 Breaking
GET /i/richItem/{businessId}
  • Response
  • 200 response Modified
    • application/hal+json;charset=UTF-8 content type Modified
      • _embedded property Modified
        • richItemDtoList property Modified
GET /i/richItem/{businessId}/{sku}
  • Response
  • 200 response Modified
    • application/hal+json;charset=UTF-8 content type Modified
      • containsAlcohol, alcoholPercentage properties Removed

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

          Breaking

PATCH /i/richItem/{businessId}/{sku}
  • Response
  • 200 response Modified
    • application/hal+json;charset=UTF-8 content type Modified
      • containsAlcohol, alcoholPercentage properties Removed

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

          Breaking

POST /i/richItem/{businessId}/itemsBySkus
  • Response
  • 200 response Modified
    • application/hal+json;charset=UTF-8 content type Modified
      • _embedded property Modified
        • richItemDtoList property Modified
PUT /i/richItem/{businessId}/{sku}
  • Response
  • 200 response Modified
    • application/hal+json;charset=UTF-8 content type Modified
      • containsAlcohol, alcoholPercentage properties Removed

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

          Breaking

5 structure changes including:
5 Modifications
Modified 5
GET /i/richItem/{businessId}
  • Response
  • 200 response Modified
    • application/hal+json;charset=UTF-8 content type Modified
      • _embedded property Modified
        • richItemDtoList property Modified
GET /i/richItem/{businessId}/{sku}
  • Response
  • 200 response Modified
    • application/hal+json;charset=UTF-8 content type Modified
      • containsAlcohol, alcoholPercentage properties Added
PATCH /i/richItem/{businessId}/{sku}
  • Response
  • 200 response Modified
    • application/hal+json;charset=UTF-8 content type Modified
      • containsAlcohol, alcoholPercentage properties Added
POST /i/richItem/{businessId}/itemsBySkus
  • Response
  • 200 response Modified
    • application/hal+json;charset=UTF-8 content type Modified
      • _embedded property Modified
        • richItemDtoList property Modified
PUT /i/richItem/{businessId}/{sku}
  • Response
  • 200 response Modified
    • application/hal+json;charset=UTF-8 content type Modified
      • containsAlcohol, alcoholPercentage properties Added
1 structure change including:
1 Modification
Modified 1 Breaking
GET /staff/v1/businessLocations/{businessLocationId}/shift
  • Query
  • startTime, endTime query parameters Removed

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

      Breaking

  • startDate, endDate query parameters Added