# Lightspeed Restaurant K Series API ## Description This is version `1.0.0` of this API documentation. Last update on Dec 5, 2025. **Lightspeed Restaurant** offers a **REST API** in order to communicate with the data in the system. These APIs are built using the RESTful standards and adhere to the basic verb interactions as defined by the REST standard. Detailed developer guides can be found in the [Lightspeed Restaurant API Portal](https://api-portal.lsk.lightspeed.app/). These services are in continuous development and subject to change. Please find our versioning policy [here](https://api-portal.lsk.lightspeed.app/quick-start/versioning). ## Servers - Demo URL: https://api.trial.lsk.lightspeed.app (Demo URL) - Production URL: https://api.lsk.lightspeed.app (Production URL) ## Authentication ## Endpoints and operations ### [Rich Item](https://api-docs.lsk.lightspeed.app/group/endpoint-rich-item.md) - [Get allergens](https://api-docs.lsk.lightspeed.app/operation/operation-teckelgetallergens.md) - [Get locales](https://api-docs.lsk.lightspeed.app/operation/operation-teckelgetlocales.md) - [Update locales](https://api-docs.lsk.lightspeed.app/operation/operation-teckelupdatelocales.md) - [Get rich items](https://api-docs.lsk.lightspeed.app/operation/operation-teckelgetrichitems.md) - [Get rich item by sku](https://api-docs.lsk.lightspeed.app/operation/operation-teckelgetrichitem.md) - [Create or update rich item](https://api-docs.lsk.lightspeed.app/operation/operation-teckelcreateorupdaterichitem.md) - [Delete rich item](https://api-docs.lsk.lightspeed.app/operation/operation-teckeldeleterichitem.md) - [Update picture](https://api-docs.lsk.lightspeed.app/operation/operation-teckelupdaterichitempicture.md) - [Get rich items by SKUs](https://api-docs.lsk.lightspeed.app/operation/operation-teckelgetrichitembyskus.md) - [Get picture specifications](https://api-docs.lsk.lightspeed.app/operation/operation-teckelgetrichitempicturespec.md) ### [Tax Breakdown](https://api-docs.lsk.lightspeed.app/group/endpoint-tax-breakdown.md) - [Post proposed order](https://api-docs.lsk.lightspeed.app/operation/operation-tax-preview-apitaxbreakdown.md) ### [Staff](https://api-docs.lsk.lightspeed.app/group/endpoint-staff.md) - [Get Shifts](https://api-docs.lsk.lightspeed.app/operation/operation-staff-apigetshift.md) - [Get All POS Users](https://api-docs.lsk.lightspeed.app/operation/operation-staff-apigetposstaff.md) - [Create POS User](https://api-docs.lsk.lightspeed.app/operation/operation-staff-apicreateposstaff.md) - [Update POS User](https://api-docs.lsk.lightspeed.app/operation/operation-staff-apiupdateposstaff.md) - [Get All Back Office Users](https://api-docs.lsk.lightspeed.app/operation/operation-staff-apigetbackofficestaff.md) - [Get Single User](https://api-docs.lsk.lightspeed.app/operation/operation-staff-apigetsinglestaff.md) - [Get All User Groups](https://api-docs.lsk.lightspeed.app/operation/operation-staff-apigetposusergroups.md) - [Get Single User Group](https://api-docs.lsk.lightspeed.app/operation/operation-staff-apigetposusergroupbyid.md) - [Add Business Location Access](https://api-docs.lsk.lightspeed.app/operation/operation-staff-apiaddstaffbusinesslocationaccess.md) - [Remove Business Location Access](https://api-docs.lsk.lightspeed.app/operation/operation-staff-apideletestaffbusinesslocationaccess.md) - [Get Webhooks](https://api-docs.lsk.lightspeed.app/operation/operation-staff-apigetwebhooks.md) - [Create Webhook](https://api-docs.lsk.lightspeed.app/operation/operation-staff-apicreatewebhook.md) - [Delete Webhook](https://api-docs.lsk.lightspeed.app/operation/operation-staff-apideletewebhook.md) - [Update Existing Webhook](https://api-docs.lsk.lightspeed.app/operation/operation-staff-apiupdatewebhook.md) - [Get Report Access Levels](https://api-docs.lsk.lightspeed.app/operation/operation-staff-apigetreportaccesslevels.md) - [Get All Back Office User Permissions](https://api-docs.lsk.lightspeed.app/operation/operation-staff-apigetbackofficeuserpermissions.md) - [Get All POS User Permissions](https://api-docs.lsk.lightspeed.app/operation/operation-staff-apigetposuserpermissions.md) ### [Reservations for Platforms](https://api-docs.lsk.lightspeed.app/group/endpoint-reservations-for-platforms.md) - [Callback to Complete Onboarding](https://api-docs.lsk.lightspeed.app/operation/operation-reservation-serviceonboardingcallback.md) - [Platform Profile Details](https://api-docs.lsk.lightspeed.app/operation/operation-reservation-servicegetbyplatformcode.md) - [Create or Update Platform Profile](https://api-docs.lsk.lightspeed.app/operation/operation-reservation-servicesetbyplatformcode.md) - [Platform course settings definition](https://api-docs.lsk.lightspeed.app/operation/operation-reservation-serviceplatformcoursesettings.md) - [Create or Update Reservation](https://api-docs.lsk.lightspeed.app/operation/operation-reservation-servicepushplatformreservation.md) - [Add authentication by XApiKey](https://api-docs.lsk.lightspeed.app/operation/operation-reservation-serviceactivateapikeysauth.md) - [Add authentication with BasicAuth](https://api-docs.lsk.lightspeed.app/operation/operation-reservation-serviceactivatebasicauth.md) - [Add authentication with BearerAuth](https://api-docs.lsk.lightspeed.app/operation/operation-reservation-serviceactivatebearerauthauth.md) - [Add authentication with OAuth2](https://api-docs.lsk.lightspeed.app/operation/operation-reservation-serviceactivateoauth2.md) - [Get Business Locations](https://api-docs.lsk.lightspeed.app/operation/operation-reservation-servicegetbusinesslocations.md) - [Activate Integration for Restaurant](https://api-docs.lsk.lightspeed.app/operation/operation-reservation-serviceactivateplatformintegration.md) - [Deactivate Integration for Restaurant](https://api-docs.lsk.lightspeed.app/operation/operation-reservation-servicedeactivateplatformintegration.md) ### [PMS](https://api-docs.lsk.lightspeed.app/group/endpoint-pms.md) - [Get PMS Revenue Centers](https://api-docs.lsk.lightspeed.app/operation/operation-pms-apigetrevenuecenters.md) - [Get a PMS provider by ID](https://api-docs.lsk.lightspeed.app/operation/operation-pms-apigetprovider.md) - [Update a PMS provider](https://api-docs.lsk.lightspeed.app/operation/operation-pms-apiupdateprovider.md) - [Delete a PMS provider](https://api-docs.lsk.lightspeed.app/operation/operation-pms-apideleteprovider.md) - [Get PMS providers](https://api-docs.lsk.lightspeed.app/operation/operation-pms-apigetproviders.md) - [Create PMS provider](https://api-docs.lsk.lightspeed.app/operation/operation-pms-apicreateprovider.md) ### [Items](https://api-docs.lsk.lightspeed.app/group/endpoint-items.md) - [Get Item by ID](https://api-docs.lsk.lightspeed.app/operation/operation-items-apigetitembyid.md) - [Update Item by ID](https://api-docs.lsk.lightspeed.app/operation/operation-items-apiput.md) - [Get All Items](https://api-docs.lsk.lightspeed.app/operation/operation-items-apigetitems.md) - [Create Item](https://api-docs.lsk.lightspeed.app/operation/operation-items-apicreateitem.md) ### [Reservations](https://api-docs.lsk.lightspeed.app/group/endpoint-reservations.md) - [Get a webhook endpoint](https://api-docs.lsk.lightspeed.app/operation/operation-irenegetwebhookendpoint.md) - [Delete a webhook endpoint](https://api-docs.lsk.lightspeed.app/operation/operation-irenedeletewebhookendpoint.md) ### [ID Cards](https://api-docs.lsk.lightspeed.app/group/endpoint-id-cards.md) - [Create an ID Card Batch](https://api-docs.lsk.lightspeed.app/operation/operation-id-cards-apicreateidcardbatch.md) - [Create ID Cards](https://api-docs.lsk.lightspeed.app/operation/operation-id-cards-apicreateidcards.md) ### [Financial](https://api-docs.lsk.lightspeed.app/group/endpoint-financial.md) - [Get Businesses](https://api-docs.lsk.lightspeed.app/operation/operation-financial-apigetbusinesses.md) - [Get Tax Rates](https://api-docs.lsk.lightspeed.app/operation/operation-financial-apigettaxrates.md) - [Get Payment Methods](https://api-docs.lsk.lightspeed.app/operation/operation-financial-apigetpaymentmethods.md) - [Get Accounting Groups](https://api-docs.lsk.lightspeed.app/operation/operation-financial-apigetaccountinggroups.md) - [Get Financials](https://api-docs.lsk.lightspeed.app/operation/operation-financial-apigetfinancials.md) - [Get Daily Financials](https://api-docs.lsk.lightspeed.app/operation/operation-financial-apigetdailyfinancials.md) - [Get Receipt by External Reference](https://api-docs.lsk.lightspeed.app/operation/operation-financial-apigetreceiptbyexternalreference.md) - [Get Aggregated Sales](https://api-docs.lsk.lightspeed.app/operation/operation-financial-apigetaggregatedsales.md) ### [FinancialV2](https://api-docs.lsk.lightspeed.app/group/endpoint-financialv2.md) - [Get Sales](https://api-docs.lsk.lightspeed.app/operation/operation-financial-apigetbusinesslocationsales.md) - [Get business day sales](https://api-docs.lsk.lightspeed.app/operation/operation-financial-apigetbusinesslocationsalesofabusinessday.md) - [BETA - Get Aborted Orders](https://api-docs.lsk.lightspeed.app/operation/operation-financial-apigetbusinesslocationabortedordersofabusinessday.md) ### [Order and Pay](https://api-docs.lsk.lightspeed.app/group/endpoint-order-and-pay.md) - [Get Businesses](https://api-docs.lsk.lightspeed.app/operation/operation-apelookupbusinesses.md) - [Get All Floorplans](https://api-docs.lsk.lightspeed.app/operation/operation-apelookupfloorplans.md) - [Get Floorplan Tables](https://api-docs.lsk.lightspeed.app/operation/operation-apegettables.md) - [Get All Order Profiles](https://api-docs.lsk.lightspeed.app/operation/operation-apeaccountprofiles.md) - [Get Single Order Profile](https://api-docs.lsk.lightspeed.app/operation/operation-apegetaccountprofile.md) - [Get All Menus](https://api-docs.lsk.lightspeed.app/operation/operation-apeloadmenus.md) - [Get Single Menu](https://api-docs.lsk.lightspeed.app/operation/operation-apegetmenubyid.md) - [Get Modifiers](https://api-docs.lsk.lightspeed.app/operation/operation-apeloadallmodifiers.md) - [Get Discounts](https://api-docs.lsk.lightspeed.app/operation/operation-apeloadalldiscounts.md) - [Create Local Order](https://api-docs.lsk.lightspeed.app/operation/operation-apelocalorder.md) - [Create To Go Order](https://api-docs.lsk.lightspeed.app/operation/operation-apeplacetogoorder.md) - [Get All Open Checks](https://api-docs.lsk.lightspeed.app/operation/operation-apegetcheck.md) - [Get Open Check by Table](https://api-docs.lsk.lightspeed.app/operation/operation-apechecklookup.md) - [Get Single Check](https://api-docs.lsk.lightspeed.app/operation/operation-apechecklookupwithaccountidentifier.md) - [Apply a Payment](https://api-docs.lsk.lightspeed.app/operation/operation-apemakepayment.md) - [Print Message](https://api-docs.lsk.lightspeed.app/operation/operation-apeprintmsg.md) - [Get Item Availability Information](https://api-docs.lsk.lightspeed.app/operation/operation-apegetrestricteditems.md) - [Get Item Availability Information by POST](https://api-docs.lsk.lightspeed.app/operation/operation-apegetrestricteditemsbypost.md) ### [Order and Pay: Webhook](https://api-docs.lsk.lightspeed.app/group/endpoint-order-and-pay-webhook.md) - [Create a Webhook](https://api-docs.lsk.lightspeed.app/operation/operation-apecreatewebhookoo.md) - [Update a webhook](https://api-docs.lsk.lightspeed.app/operation/operation-apeupdatewebhookoo.md) - [Retrieve a Webhook](https://api-docs.lsk.lightspeed.app/operation/operation-apegetwebhookoo.md) - [Delete a Webhook](https://api-docs.lsk.lightspeed.app/operation/operation-apedeletewebhookendpoint.md) - [Get webhook business locations](https://api-docs.lsk.lightspeed.app/operation/operation-apegetwebhookbusinesslocations.md) - [Add a Business Location to a Webhook](https://api-docs.lsk.lightspeed.app/operation/operation-apeaddwebhookbusinesslocation.md) - [Remove Business Location from a Webhook](https://api-docs.lsk.lightspeed.app/operation/operation-aperemovewebhookbusinesslocation.md) ## Webhooks ### [Staff](https://api-docs.lsk.lightspeed.app/group/webhook-staff.md) - [Shift notification](https://api-docs.lsk.lightspeed.app/operation/operation-shiftnotification.md) ### [Reservations for Platforms](https://api-docs.lsk.lightspeed.app/group/webhook-reservations-for-platforms.md) - [Error notification](https://api-docs.lsk.lightspeed.app/operation/operation-reservationerrornotification.md) - [Integration notification](https://api-docs.lsk.lightspeed.app/operation/operation-reservationintegrationnotification.md) - [Onboarding notification](https://api-docs.lsk.lightspeed.app/operation/operation-reservationonboardingnotification.md) - [Order notification](https://api-docs.lsk.lightspeed.app/operation/operation-reservationordernotification.md) - [POS reservation updated notification](https://api-docs.lsk.lightspeed.app/operation/operation-posreservationupdatednotification.md) ### [Order and Pay](https://api-docs.lsk.lightspeed.app/group/webhook-order-and-pay.md) - [Order Notification](https://api-docs.lsk.lightspeed.app/operation/operation-onlineordernotification.md) - [Payment Notification](https://api-docs.lsk.lightspeed.app/operation/operation-onlinepaymentnotification.md) - [Item Availability Notification](https://api-docs.lsk.lightspeed.app/operation/operation-salesrestrictionupdatednotification.md) ### [PMS Integration](https://api-docs.lsk.lightspeed.app/group/webhook-pms-integration.md) - [Transaction Details](https://api-docs.lsk.lightspeed.app/operation/operation-transactiondetails.md) [Powered by Bump.sh](https://bump.sh)