Overview
- API URLs
- Creating a Kounta by Lightspeed Add-on
- Authentication
- Content Type
- Data Types
- Response Patterns
- Pagination
- Caching
- Errors
- PUT vs PATCH
- Testing
Authentication
- Basic Access Authorization
- OAuth 2.0
- Rate Limiting
Libraries

Addresses
- Get addresses
Billing
- Get add-on subscription info
- Get add-on subscription payments info
- Create an add-on subscription
- Update an add-on subscription
- Cancel an add-on subscription
- Webhooks
Categories
- Get all categories
- Get a category
- Create a category
- Update a category
- Add/remove a product to/from a category
- Webhooks
Checkins
- Get all customers' valid checkins for a site
- Get a customer's valid checkin
- Create a Checkin
- Checkout (Delete a Checkin Record)
Companies
- Get a company
- Check the statuses of all sites
Customers
- Get all customers
- Get a customer
- Create a customer
- Update a customer
- Webhooks
Images
- Direct Assignment
- Delete an image
Inventory
- Get stock levels
- Webhooks
Lines
- Add a line to an order
- Update a line
- Delete a line
Notifications
- Add a notification
- Update a notification
- Get all notifications
- Get a notification
Option Sets
- Get all option sets
- Get an option set
- Create an option set
- Webhooks
Orders
- Get orders
- Get an order
- Create an order
- Create with Option Sets
- Update an order
- Refund an order
- Option sets
- Get an option set
- Add an option set
- Delete an option set
- Pass Thru Printing
- Webhooks
Payment Methods
- Get payment methods
- Get a payment method
- Webhooks
Payments
- Add a payment to an order
- Update a payment
Price Lists
- Get all price lists
- Get a price list
Products
- List products
- Get a product
- Create a product
- Update a product
- Webhooks
- Units
Purchase Orders
- Get purchase orders
- Get a purchase order
- Webhooks
Reconciliations
- Get reconciliations
- Get a reconciliation
- Update a reconciliation
- Webhooks
Registers
- Get registers
- Get a register
- Webhooks
Reporting Groups
- Get all reporting groups
- Get a reporting group
- Create a reporting group
- Update a reporting group
- Delete a reporting group
- Add products to a reporting group
- Remove a product from a reporting group
Shifts
- Get shifts
- Webhooks
Sites
- Get all sites
- Get a site
- Update an existing site
- Check the status of a site
- Check status of all authorised sites
- Webhooks
Staff
- Get all staff
- Get a staff member
- Permissions
- Create a staff member
- Update a staff member
- Delete a staff member
- Webhooks
Tables
- Get all tables for a site
- Get orders on a table
Taxes
- Get all taxes
- Get a tax
- Create a tax
- Get all tax groups
- Get a tax group
- Webhooks
Webhooks
- Get webhooks
- Create a webhook
- Update a webhook
- Delete a webhook
- Testing a webhook
- Supported topics
- Filtering
- Exponential backoff
- Verifying webhooks
- Dynamic headers

Checkins

Authenticated customers can use checkin service.

Get all customers' valid checkins for a site

GET /v1/companies/5678/sites/3232/checkins Get all Checkins

Get a customer's valid checkin

GET /v1/companies/5678/sites/3232/checkins/389427 Get a customer's Active Checkin

A customer can have no more than one valid checkin.
If the user requested is not checked in, you will receive a HTTP 404 with error message This customer is not checked in.

Create a Checkin

Creation of new checkin is currently limited to the fields below.

POST /v1/companies/5678/sites/3232/checkins Create a new customer

Only customer_id is required.
duration is set to 120 by default. You may specify the value of duration between 5 and 180.
Each customer should have only one valid checkin. If you try to create a checkin record for a customer who already checked in, you will have a HTTP 400 error.

Checkout (Delete a Checkin Record)

No Request Body Required to Checkout a Customer

DELETE /v1/companies/5678/sites/3232/checkins/389427 Checkout