Features

Introduction

This section outlines the relevant features of the Lightspeed Restaurant POS K-Series Financial API, Items API and the endpoints available to manage these features.

Inventory levels are not currently available via the APIs. The only way to maintain accurate inventory levels is to monitor the sales data and adjust inventory levels accordingly.

Business Details

Retrieve Business Information

Provides a list of all businesses and business locations associated with the access token.

• Method: GET
• URL: /f/data/businesses
• API Reference: List Businesses

Items Details

Retrieve Items for a Business Location

Offers detailed information about items within a business location.

• Method: GET
• URL: /items/v1/items
• API Reference: Get Items by Business Location

Accounting Groups and Financial Data

Retrieve Accounting Groups for a Business Location

Offers detailed information about each accounting group within a business location.

• Method: GET
• URL: /f/finance/businessLocationId/accountingGroups
• API Reference: Get Accounting Groups

Retrieve Aggregated Sales Data

Provides aggregated sales data for the current business day or a specified date range.

• Method: GET
• URL: /f/finance/businessLocationId/aggregatedSales
• API Reference:Get Aggregated Sales

Retrieve Daily Financial Data

Returns the financial data for the current business day or a specific date.

• Method: GET
• URL: /f/finance/businessLocationId/dailyFinancials
• API Reference: Get Daily Financials

Retrieve Financial Data for a Date Range

Provides financial data for a business location within a specified date range.

• Method: GET
• URL: /f/finance/businessLocationId/financials/{from}/{to}
• API Reference: Get Financials