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
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
POST {subscriber-host}/chargewebhook
  • 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
POST Charge Transactionwebhook
  • 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
POST Charge Transactionwebhook
  • 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
1 structure change including:
1 Addition
Added 1
POST Charge Transactionwebhook
1 structure change including:
1 Addition
Added 1
GET /staff/v1/businessLocations/{businessLocationId}/shift
1 structure change including:
1 Breaking change
1 Removal
Removed 1 Breaking
GET /staff/v1/businessLocations/{businessLocationId}/shift
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
4 structure changes including:
4 Modifications
Modified 4 Breaking
GET /items/v1/items
  • Response
  • 200 response Modified
    • application/json content type Modified
      • coursingOptions, productionInstructions properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /items/v1/items/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • coursingOptions, productionInstructions properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /items/v1/items
  • Body
  • application/json content type Modified
    • businessLocationId property Modified
      • Property is no longer required
      • businessLocationId property Modified
        • Property is no longer required
    • accountingGroupId property Modified
      • Property is no longer required
      • accountingGroupId property Modified
        • Property is no longer required
  • Response
  • 201 response Modified
    • application/json content type Modified
      • coursingOptions, productionInstructions properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PUT /items/v1/items/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • coursingOptions, productionInstructions properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
12 structure changes including:
6 Breaking changes
6 Additions
6 Removals
Removed 6 Breaking
DELETE /staff/v1/businessLocations/{businessLocationId}/webhooks/{webhookId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /staff/v1/businessLocations/{businessLocationId}/shift
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /staff/v1/businessLocations/{businessLocationId}/webhooks
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /staff/v1/businessLocations/{businessLocationId}/webhooks/{webhookId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /staff/v1/businessLocations/{businessLocationId}/webhooks
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST Shift notificationwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 6
DELETE /staff/v1/businessLocations/{businessLocationId}/webhooks/{webhookId}
GET /staff/v1/businessLocations/{businessLocationId}/shift
GET /staff/v1/businessLocations/{businessLocationId}/webhooks
PATCH /staff/v1/businessLocations/{businessLocationId}/webhooks/{webhookId}
POST /staff/v1/businessLocations/{businessLocationId}/webhooks
POST Shift notificationwebhook
8 structure changes including:
6 Additions
2 Modifications
Modified 2 Breaking
GET /f/finance/{businessLocationId}/tax-rates
  • Response
  • 200 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/data/{businessLocationId}/floorplans
  • Query
  • expandTables query parameter Added
Added 6
DELETE /staff/v1/businessLocations/{businessLocationId}/webhooks/{webhookId}
GET /o/op/data/{businessLocationId}/account-profiles/tagcode/{tagCode}
GET /staff/v1/businessLocations/{businessLocationId}/webhooks
PATCH /staff/v1/businessLocations/{businessLocationId}/webhooks/{webhookId}
POST /staff/v1/businessLocations/{businessLocationId}/webhooks
POST Shift notificationwebhook
4 structure changes including:
4 Modifications
Modified 4
GET /items/v1/items
  • Response
  • 200 response Modified
    • application/json content type Modified
      • coursingOptions, productionInstructions properties Added
GET /items/v1/items/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • coursingOptions, productionInstructions properties Added
POST /items/v1/items
  • Response
  • 201 response Modified
    • application/json content type Modified
      • coursingOptions, productionInstructions properties Added
PUT /items/v1/items/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • coursingOptions, productionInstructions properties Added
1 structure change including:
1 Modification
Modified 1
GET /f/v2/business-location/{businessLocationId}/sales
  • Query
  • to query parameter Modified
    • Query parameter is no longer required
1 structure change including:
1 Modification
Modified 1
GET /reservation/api/1/platform/{platform-code}/order-webhook-sample
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified