OVERALL CONTROL / 0.6-customer-control
Grades and scoring
Data access
25% of the overall score before applicability adjustment.
Scored answers and evidence
Read interface 7.5/10
Structured APIs across the declared product scope
Lightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events.
The permitted custom route reads structured K-Series financial sales and item catalog records for selected business locations. Financial records include receipt identities, totals and associated sale detail; item records include identities, prices and active state. This is the Restaurant K-Series product, not Lightspeed Retail.
Lightspeed Restaurant K-Series retrieve financial sales ↗
GET /f/v2/business-location/{businessLocationId}/sales; from/to, max 365-day window, pageSize and nextPageToken; financial record fields · Checked 2026-10-17
Lightspeed Restaurant K-Series retrieve items ↗
GET /items/v1/items; businessLocationId, offset/amount, SKU/name filters, item IDs and active state · Checked 2026-10-17
Lightspeed Restaurant K-Series API documentation ↗
K-Series product scope; Financial and Items API families and OAuth scopes; distinct Orders API · Checked 2026-10-17
Bulk delivery 8.8/10
Batched or iterable API requests
Lightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events.
Sales can be traversed with nextPageToken over date windows of at most 365 days. Item listing uses offset/amount pagination. Repeating those traversals collects the available scoped records; no delivered database replica or whole-product backup is established.
Lightspeed Restaurant K-Series retrieve financial sales ↗
GET /f/v2/business-location/{businessLocationId}/sales; from/to, max 365-day window, pageSize and nextPageToken; financial record fields · Checked 2026-10-17
Lightspeed Restaurant K-Series retrieve items ↗
GET /items/v1/items; businessLocationId, offset/amount, SKU/name filters, item IDs and active state · Checked 2026-10-17
Query expressiveness 8.8/10
Documented structured API filters
Lightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events.
Sales accept from/to time boundaries; items accept location, SKU, name, accounting-group and ID filters. Item ID requests ignore offset/amount. These fixed query surfaces do not establish SQL access.
Lightspeed Restaurant K-Series retrieve financial sales ↗
GET /f/v2/business-location/{businessLocationId}/sales; from/to, max 365-day window, pageSize and nextPageToken; financial record fields · Checked 2026-10-17
Lightspeed Restaurant K-Series retrieve items ↗
GET /items/v1/items; businessLocationId, offset/amount, SKU/name filters, item IDs and active state · Checked 2026-10-17
Access cost barrier 5.0/10
Higher plan, separately licensed add-on or fixed recurring access fee
Lightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events.
The K-Series merchant custom API is explicitly a paid add-on requested through the Account Manager. No price amount, universal regional entitlement or named minimum POS plan is established here. These custom-route conditions do not establish separate partner-program fees.
Lightspeed Restaurant K-Series custom integrations ↗
Paid add-on; one-business use; Financial and Items APIs; excluded APIs and RTN/webhooks; polling and OAuth client provisioning · Checked 2026-10-17
Third-party accessibility
20% of the overall score before applicability adjustment.
Scored answers and evidence
Third-party eligibility 5.0/10
Separate provider consent or partner agreement required
Lightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events.
Lightspeed reserves API access for approved merchants and partners. A merchant requests a paid one-business custom client through its Account Manager and may hire a trusted developer. Reusable multi-merchant distribution instead requires the partner path; merchant authorization alone does not establish partner eligibility.
Lightspeed Restaurant K-Series API introduction ↗
Eligibility for approved merchants and integration partners; merchant Account Manager versus multi-merchant partner application · Checked 2026-10-17
Lightspeed Restaurant K-Series custom integrations ↗
Paid add-on; one-business use; Financial and Items APIs; excluded APIs and RTN/webhooks; polling and OAuth client provisioning · Checked 2026-10-17
Downstream permission -
-
Lightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events.
The custom integration guide permits development for one merchant business and restricts commercialization or sharing across merchants without a formal partnership. It does not establish the applicable downstream data-processing, AI or redistribution license; those rights remain unresolved.
Lightspeed Restaurant K-Series custom integrations ↗
Paid add-on; one-business use; Financial and Items APIs; excluded APIs and RTN/webhooks; polling and OAuth client provisioning · Checked 2026-10-17
External action
15% of the overall score before applicability adjustment.
Scored answers and evidence
Write interface 7.5/10
Create and update in one business domain
Lightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events.
Within the custom route’s Items API, POST /items/v1/items creates a catalog item and PUT /items/v1/items/{id} updates one, including price and active/archive state. Appropriate item scope and location authorization are required. This does not grant order submission, payments or inventory-ledger mutations.
Lightspeed Restaurant K-Series create an item ↗
POST /items/v1/items; OAuth items scope; item name, location, SKU, accounting group and price; 201 response · Checked 2026-10-17
Lightspeed Restaurant K-Series update an item ↗
PUT /items/v1/items/{id}; OAuth items scope; required fields, active archive state and validation errors · Checked 2026-10-17
Lightspeed Restaurant K-Series custom integrations ↗
Paid add-on; one-business use; Financial and Items APIs; excluded APIs and RTN/webhooks; polling and OAuth client provisioning · Checked 2026-10-17
Custom application path 5.0/10
Approved third-party applications using fixed interfaces
Lightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events.
A restaurant may use its team or a trusted third-party developer for a provider-provisioned custom integration on fixed Financial and Items APIs. One-business limits and provider approval remain; public multi-merchant applications require a separate partner agreement.
Lightspeed Restaurant K-Series custom integrations ↗
Paid add-on; one-business use; Financial and Items APIs; excluded APIs and RTN/webhooks; polling and OAuth client provisioning · Checked 2026-10-17
Lightspeed Restaurant K-Series API introduction ↗
Eligibility for approved merchants and integration partners; merchant Account Manager versus multi-merchant partner application · Checked 2026-10-17
Continuity
15% of the overall score before applicability adjustment.
Scored answers and evidence
Refresh mechanism 5.0/10
Scheduled feeds or recurring extracts
Lightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events.
The custom route documents recurring API polling, including hourly financial extraction, while excluding webhooks and Real-Time Notifications. Repeated sales windows and catalog traversals provide recurring extracts, not an updated-since catalog cursor or an ordered change stream.
Lightspeed Restaurant K-Series custom integrations ↗
Paid add-on; one-business use; Financial and Items APIs; excluded APIs and RTN/webhooks; polling and OAuth client provisioning · Checked 2026-10-17
Lightspeed Restaurant K-Series retrieve financial sales ↗
GET /f/v2/business-location/{businessLocationId}/sales; from/to, max 365-day window, pageSize and nextPageToken; financial record fields · Checked 2026-10-17
Lightspeed Restaurant K-Series retrieve items ↗
GET /items/v1/items; businessLocationId, offset/amount, SKU/name filters, item IDs and active state · Checked 2026-10-17
Limit visibility 7.5/10
Numeric usage or polling guidance
Lightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events.
The custom integration guide gives hourly polling as an example. This is numeric cadence guidance, not a requests-per-second quota or guaranteed capacity. K-Series service-wide limits and a throttle/reset contract remain unverified; no Lightspeed Retail quota is imported.
Lightspeed Restaurant K-Series custom integrations ↗
Paid add-on; one-business use; Financial and Items APIs; excluded APIs and RTN/webhooks; polling and OAuth client provisioning · Checked 2026-10-17
CDC and deletion capture 2.5/10
Full snapshots permit customer reconciliation; native deltas unverified
Lightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events.
Item records expose active/archive state. Repeating the full permitted catalog and bounded financial traversals supports current-state comparison, but no uniform hard-delete identity or complete financial change log is established. Treat location/grant changes separately from deletion.
Lightspeed Restaurant K-Series retrieve items ↗
GET /items/v1/items; businessLocationId, offset/amount, SKU/name filters, item IDs and active state · Checked 2026-10-17
Lightspeed Restaurant K-Series update an item ↗
PUT /items/v1/items/{id}; OAuth items scope; required fields, active archive state and validation errors · Checked 2026-10-17
Lightspeed Restaurant K-Series retrieve financial sales ↗
GET /f/v2/business-location/{businessLocationId}/sales; from/to, max 365-day window, pageSize and nextPageToken; financial record fields · Checked 2026-10-17
Replay and gap recovery 2.5/10
Rebuild from a fresh snapshot; no historical replay established
Lightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events.
Repeat item pagination and dated sales traversal to rebuild the available current collection for the authorized business locations. That recovery excludes unavailable prior versions and deleted payloads; no retained webhook replay is established on this custom route.
Lightspeed Restaurant K-Series retrieve items ↗
GET /items/v1/items; businessLocationId, offset/amount, SKU/name filters, item IDs and active state · Checked 2026-10-17
Lightspeed Restaurant K-Series retrieve financial sales ↗
GET /f/v2/business-location/{businessLocationId}/sales; from/to, max 365-day window, pageSize and nextPageToken; financial record fields · Checked 2026-10-17
Lightspeed Restaurant K-Series custom integrations ↗
Paid add-on; one-business use; Financial and Items APIs; excluded APIs and RTN/webhooks; polling and OAuth client provisioning · Checked 2026-10-17
Data exit
20% of the overall score before applicability adjustment.
Scored answers and evidence
Export custody 7.5/10
Customer-held structured files or API records
Lightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events.
Financial and catalog responses provide structured records that an authorized integration can retain outside the POS. This supports customer-held record custody, without evidence of a provider-delivered database, all attachments or transferable native configuration.
Lightspeed Restaurant K-Series retrieve financial sales ↗
GET /f/v2/business-location/{businessLocationId}/sales; from/to, max 365-day window, pageSize and nextPageToken; financial record fields · Checked 2026-10-17
Lightspeed Restaurant K-Series retrieve items ↗
GET /items/v1/items; businessLocationId, offset/amount, SKU/name filters, item IDs and active state · Checked 2026-10-17
Post-cancellation access Disclosure
-
Disclosure only; does not reduce planned-exit credit.
Lightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events.
The technical custom-access guide describes provisioning and integration scope, without a merchant cancellation retrieval window or guaranteed continued API availability. Plan-specific termination and data-retention rights require applicable merchant terms.
Lightspeed Restaurant K-Series custom integrations ↗
Paid add-on; one-business use; Financial and Items APIs; excluded APIs and RTN/webhooks; polling and OAuth client provisioning · Checked 2026-10-17
Planned migration fidelity 7.5/10
Portable structured records on documented routes; whole-product completeness unverified
Lightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events.
Sales and catalog responses preserve financial receipt/item identities and structured fields for scoped migration. They do not establish a restorable restaurant database, all documents, complete edit history or export of every POS workflow and configuration.
Lightspeed Restaurant K-Series retrieve financial sales ↗
GET /f/v2/business-location/{businessLocationId}/sales; from/to, max 365-day window, pageSize and nextPageToken; financial record fields · Checked 2026-10-17
Lightspeed Restaurant K-Series retrieve items ↗
GET /items/v1/items; businessLocationId, offset/amount, SKU/name filters, item IDs and active state · Checked 2026-10-17
Business logic and customization
5% of the overall score before applicability adjustment.
Scored answers and evidence
Logic authoring 2.5/10
External integration code; native business logic portability not established
Lightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events.
A restaurant or hired developer can build a custom application against the permitted APIs (external code). Creating item records does not establish exportable native restaurant workflows or independent execution of POS business logic.
Lightspeed Restaurant K-Series custom integrations ↗
Paid add-on; one-business use; Financial and Items APIs; excluded APIs and RTN/webhooks; polling and OAuth client provisioning · Checked 2026-10-17
Lightspeed Restaurant K-Series create an item ↗
POST /items/v1/items; OAuth items scope; item name, location, SKU, accounting group and price; 201 response · Checked 2026-10-17
Rights to custom logic -
-
Lightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events.
The reviewed K-Series API scope and integration guide do not establish ownership, reusable export or independent execution rights for native POS workflow definitions. API client development is a separate artifact.
Lightspeed Restaurant K-Series custom integrations ↗
Paid add-on; one-business use; Financial and Items APIs; excluded APIs and RTN/webhooks; polling and OAuth client provisioning · Checked 2026-10-17
Lightspeed Restaurant K-Series API documentation ↗
K-Series product scope; Financial and Items API families and OAuth scopes; distinct Orders API · Checked 2026-10-17
Scores are out of 10. * Incomplete evidence discounts verified capabilities (unknown answers stay unknown). Planned migration drives data exit. Scoring method ↗
CUSTOMER CHOICE
Third-party accessibility
Lightspeed reserves API access for approved merchants and partners. A merchant requests a paid one-business custom client through its Account Manager and may hire a trusted developer. Reusable multi-merchant distribution instead requires the partner path; merchant authorization alone does not establish partner eligibility.
Confirm who can connect, who owns the credentials and which uses are permitted. Customer consent and provider approval can be separate requirements; the selected plan and contract still matter.
READ / INTEGRATE
API and export routes
The permitted custom route reads structured K-Series financial sales and item catalog records for selected business locations. Financial records include receipt identities, totals and associated sale detail; item records include identities, prices and active state. This is the Restaurant K-Series product, not Lightspeed Retail. Sales can be traversed with nextPageToken over date windows of at most 365 days. Item listing uses offset/amount pagination. Repeating those traversals collects the available scoped records; no delivered database replica or whole-product backup is established. Sales accept from/to time boundaries; items accept location, SKU, name, accounting-group and ID filters. Item ID requests ignore offset/amount. These fixed query surfaces do not establish SQL access.
| Access route | Authentication | Credential owner | Provider approval | Access requirement | Last checked |
|---|---|---|---|---|---|
| K-Series approved merchant custom API | OAuth 2.0 | Customer | Yes | Contract required | 2026-10-17 |
| K-Series approved partner application | OAuth 2.0 | Integration provider | Yes | Partner approval | 2026-10-17 |
Availability depends on your product, plan and agreement. See the documentation below for the requirements of each route.
ECONOMIC ACCESS
Cost, authentication and limits
The K-Series merchant custom API is explicitly a paid add-on requested through the Account Manager. No price amount, universal regional entitlement or named minimum POS plan is established here. These custom-route conditions do not establish separate partner-program fees.
Check API entitlement, credential ownership and rate limits for the route you intend to use. Include review fees, customer-plan upgrades and ongoing access charges in the total.
ACT FROM OUTSIDE
External action
Within the custom route’s Items API, POST /items/v1/items creates a catalog item and PUT /items/v1/items/{id} updates one, including price and active/archive state. Appropriate item scope and location authorization are required. This does not grant order submission, payments or inventory-ledger mutations.
Validate the supported operation, acting identity and permission scope (read access does not imply write permission). Ambiguous retries and revoked credentials also affect whether an external workflow can run safely.
KEEP ACCESS USEFUL
Continuity
The custom route documents recurring API polling, including hourly financial extraction, while excluding webhooks and Real-Time Notifications. Repeated sales windows and catalog traversals provide recurring extracts, not an updated-since catalog cursor or an ordered change stream. Item records expose active/archive state. Repeating the full permitted catalog and bounded financial traversals supports current-state comparison, but no uniform hard-delete identity or complete financial change log is established. Treat location/grant changes separately from deletion. Repeat item pagination and dated sales traversal to rebuild the available current collection for the authorized business locations. That recovery excludes unavailable prior versions and deleted payloads; no retained webhook replay is established on this custom route. The custom integration guide gives hourly polling as an example. This is numeric cadence guidance, not a requests-per-second quota or guaranteed capacity. K-Series service-wide limits and a throttle/reset contract remain unverified; no Lightspeed Retail quota is imported.
CDC, deletions and recovery
| Question | Answer / applicable route | Evidence |
|---|---|---|
| Can ongoing extraction identify updates and deleted records on the declared route? | Full snapshots permit customer reconciliation; native deltas unverifiedLightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events. Item records expose active/archive state. Repeating the full permitted catalog and bounded financial traversals supports current-state comparison, but no uniform hard-delete identity or complete financial change log is established. Treat location/grant changes separately from deletion. | Lightspeed Restaurant K-Series retrieve items ↗GET /items/v1/items; businessLocationId, offset/amount, SKU/name filters, item IDs and active stateChecked 2026-10-17 Lightspeed Restaurant K-Series update an item ↗PUT /items/v1/items/{id}; OAuth items scope; required fields, active archive state and validation errorsChecked 2026-10-17 Lightspeed Restaurant K-Series retrieve financial sales ↗GET /f/v2/business-location/{businessLocationId}/sales; from/to, max 365-day window, pageSize and nextPageToken; financial record fieldsChecked 2026-10-17 |
| How can extraction recover after missed events or an interrupted consumer? | Rebuild from a fresh snapshot; no historical replay establishedLightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events. Repeat item pagination and dated sales traversal to rebuild the available current collection for the authorized business locations. That recovery excludes unavailable prior versions and deleted payloads; no retained webhook replay is established on this custom route. | Lightspeed Restaurant K-Series retrieve items ↗GET /items/v1/items; businessLocationId, offset/amount, SKU/name filters, item IDs and active stateChecked 2026-10-17 Lightspeed Restaurant K-Series retrieve financial sales ↗GET /f/v2/business-location/{businessLocationId}/sales; from/to, max 365-day window, pageSize and nextPageToken; financial record fieldsChecked 2026-10-17 Lightspeed Restaurant K-Series custom integrations ↗Paid add-on; one-business use; Financial and Items APIs; excluded APIs and RTN/webhooks; polling and OAuth client provisioningChecked 2026-10-17 |
Useful ongoing access includes corrections and deletions, not only the first export. A failed request, changed filter or lost resource permission should not be interpreted as a deleted record.
LEAVE WITH YOUR DATA
Data exit and portability
Sales and catalog responses preserve financial receipt/item identities and structured fields for scoped migration. They do not establish a restorable restaurant database, all documents, complete edit history or export of every POS workflow and configuration. The technical custom-access guide describes provisioning and integration scope, without a merchant cancellation retrieval window or guaranteed continued API availability. Plan-specific termination and data-retention rights require applicable merchant terms.
Test the output against the destination’s required fields and history. Check stable identifiers, relationships, attachments and extraction time; a sample file proves only the coverage of that sample.
BUILD / INSPECT / REUSE
Business logic and customization
A restaurant or hired developer can build a custom application against the permitted APIs (external code). Creating item records does not establish exportable native restaurant workflows or independent execution of POS business logic. The reviewed K-Series API scope and integration guide do not establish ownership, reusable export or independent execution rights for native POS workflow definitions. API client development is a separate artifact.
Custom API access, ownership of workflows and the right to export their definitions are separate questions. A custom-app capability alone does not establish that business rules can move to another system.
AGREEMENTS / API DOCS / PROGRAM REQUIREMENTS
Documented conditions
Answers below come from public provider materials. Every answer retains its source check date, scope (a partner agreement does not describe every customer route). Customer contracts and live behavior still need verification.
| Question | Answer / applicable route | Evidence |
|---|---|---|
| What structured read interface is documented? | Structured APIs across the declared product scopeLightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events. The permitted custom route reads structured K-Series financial sales and item catalog records for selected business locations. Financial records include receipt identities, totals and associated sale detail; item records include identities, prices and active state. This is the Restaurant K-Series product, not Lightspeed Retail. | Lightspeed Restaurant K-Series retrieve financial sales ↗GET /f/v2/business-location/{businessLocationId}/sales; from/to, max 365-day window, pageSize and nextPageToken; financial record fieldsChecked 2026-10-17 Lightspeed Restaurant K-Series retrieve items ↗GET /items/v1/items; businessLocationId, offset/amount, SKU/name filters, item IDs and active stateChecked 2026-10-17 Lightspeed Restaurant K-Series API documentation ↗K-Series product scope; Financial and Items API families and OAuth scopes; distinct Orders APIChecked 2026-10-17 |
| How can customers retrieve data in bulk? | Batched or iterable API requestsLightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events. Sales can be traversed with nextPageToken over date windows of at most 365 days. Item listing uses offset/amount pagination. Repeating those traversals collects the available scoped records; no delivered database replica or whole-product backup is established. | Lightspeed Restaurant K-Series retrieve financial sales ↗GET /f/v2/business-location/{businessLocationId}/sales; from/to, max 365-day window, pageSize and nextPageToken; financial record fieldsChecked 2026-10-17 Lightspeed Restaurant K-Series retrieve items ↗GET /items/v1/items; businessLocationId, offset/amount, SKU/name filters, item IDs and active stateChecked 2026-10-17 |
| What queries can a customer issue outside the provider UI? | Documented structured API filtersLightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events. Sales accept from/to time boundaries; items accept location, SKU, name, accounting-group and ID filters. Item ID requests ignore offset/amount. These fixed query surfaces do not establish SQL access. | Lightspeed Restaurant K-Series retrieve financial sales ↗GET /f/v2/business-location/{businessLocationId}/sales; from/to, max 365-day window, pageSize and nextPageToken; financial record fieldsChecked 2026-10-17 Lightspeed Restaurant K-Series retrieve items ↗GET /items/v1/items; businessLocationId, offset/amount, SKU/name filters, item IDs and active stateChecked 2026-10-17 |
| Who decides whether a chosen third party may connect? | Separate provider consent or partner agreement requiredLightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events. Lightspeed reserves API access for approved merchants and partners. A merchant requests a paid one-business custom client through its Account Manager and may hire a trusted developer. Reusable multi-merchant distribution instead requires the partner path; merchant authorization alone does not establish partner eligibility. | Lightspeed Restaurant K-Series API introduction ↗Eligibility for approved merchants and integration partners; merchant Account Manager versus multi-merchant partner applicationChecked 2026-10-17 Lightspeed Restaurant K-Series custom integrations ↗Paid add-on; one-business use; Financial and Items APIs; excluded APIs and RTN/webhooks; polling and OAuth client provisioningChecked 2026-10-17 |
| What extra commercial condition applies to the routes supplying the assessed read capability, relative to the lowest paid plan? | Higher plan, separately licensed add-on or fixed recurring access feeLightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events. The K-Series merchant custom API is explicitly a paid add-on requested through the Account Manager. No price amount, universal regional entitlement or named minimum POS plan is established here. These custom-route conditions do not establish separate partner-program fees. | Lightspeed Restaurant K-Series custom integrations ↗Paid add-on; one-business use; Financial and Items APIs; excluded APIs and RTN/webhooks; polling and OAuth client provisioningChecked 2026-10-17 |
| What permission is needed for the documented downstream use? | -Lightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events. The custom integration guide permits development for one merchant business and restricts commercialization or sharing across merchants without a formal partnership. It does not establish the applicable downstream data-processing, AI or redistribution license; those rights remain unresolved. | Lightspeed Restaurant K-Series custom integrations ↗Paid add-on; one-business use; Financial and Items APIs; excluded APIs and RTN/webhooks; polling and OAuth client provisioningChecked 2026-10-17 |
| Which external write operations are documented? | Create and update in one business domainLightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events. Within the custom route’s Items API, POST /items/v1/items creates a catalog item and PUT /items/v1/items/{id} updates one, including price and active/archive state. Appropriate item scope and location authorization are required. This does not grant order submission, payments or inventory-ledger mutations. | Lightspeed Restaurant K-Series create an item ↗POST /items/v1/items; OAuth items scope; item name, location, SKU, accounting group and price; 201 responseChecked 2026-10-17 Lightspeed Restaurant K-Series update an item ↗PUT /items/v1/items/{id}; OAuth items scope; required fields, active archive state and validation errorsChecked 2026-10-17 Lightspeed Restaurant K-Series custom integrations ↗Paid add-on; one-business use; Financial and Items APIs; excluded APIs and RTN/webhooks; polling and OAuth client provisioningChecked 2026-10-17 |
| How can customers connect an application they build or choose? | Approved third-party applications using fixed interfacesLightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events. A restaurant may use its team or a trusted third-party developer for a provider-provisioned custom integration on fixed Financial and Items APIs. One-business limits and provider approval remain; public multi-merchant applications require a separate partner agreement. | Lightspeed Restaurant K-Series custom integrations ↗Paid add-on; one-business use; Financial and Items APIs; excluded APIs and RTN/webhooks; polling and OAuth client provisioningChecked 2026-10-17 Lightspeed Restaurant K-Series API introduction ↗Eligibility for approved merchants and integration partners; merchant Account Manager versus multi-merchant partner applicationChecked 2026-10-17 |
| What mechanism supports repeatable extraction of changes? | Scheduled feeds or recurring extractsLightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events. The custom route documents recurring API polling, including hourly financial extraction, while excluding webhooks and Real-Time Notifications. Repeated sales windows and catalog traversals provide recurring extracts, not an updated-since catalog cursor or an ordered change stream. | Lightspeed Restaurant K-Series custom integrations ↗Paid add-on; one-business use; Financial and Items APIs; excluded APIs and RTN/webhooks; polling and OAuth client provisioningChecked 2026-10-17 Lightspeed Restaurant K-Series retrieve financial sales ↗GET /f/v2/business-location/{businessLocationId}/sales; from/to, max 365-day window, pageSize and nextPageToken; financial record fieldsChecked 2026-10-17 Lightspeed Restaurant K-Series retrieve items ↗GET /items/v1/items; businessLocationId, offset/amount, SKU/name filters, item IDs and active stateChecked 2026-10-17 |
| How are integration limits disclosed? | Numeric usage or polling guidanceLightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events. The custom integration guide gives hourly polling as an example. This is numeric cadence guidance, not a requests-per-second quota or guaranteed capacity. K-Series service-wide limits and a throttle/reset contract remain unverified; no Lightspeed Retail quota is imported. | Lightspeed Restaurant K-Series custom integrations ↗Paid add-on; one-business use; Financial and Items APIs; excluded APIs and RTN/webhooks; polling and OAuth client provisioningChecked 2026-10-17 |
| Where can a usable data copy be delivered? | Customer-held structured files or API recordsLightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events. Financial and catalog responses provide structured records that an authorized integration can retain outside the POS. This supports customer-held record custody, without evidence of a provider-delivered database, all attachments or transferable native configuration. | Lightspeed Restaurant K-Series retrieve financial sales ↗GET /f/v2/business-location/{businessLocationId}/sales; from/to, max 365-day window, pageSize and nextPageToken; financial record fieldsChecked 2026-10-17 Lightspeed Restaurant K-Series retrieve items ↗GET /items/v1/items; businessLocationId, offset/amount, SKU/name filters, item IDs and active stateChecked 2026-10-17 |
| What retrieval rights are documented at cancellation? | -Lightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events. The technical custom-access guide describes provisioning and integration scope, without a merchant cancellation retrieval window or guaranteed continued API availability. Plan-specific termination and data-retention rights require applicable merchant terms. | Lightspeed Restaurant K-Series custom integrations ↗Paid add-on; one-business use; Financial and Items APIs; excluded APIs and RTN/webhooks; polling and OAuth client provisioningChecked 2026-10-17 |
| How can customers define their own business logic? | External integration code; native business logic portability not establishedLightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events. A restaurant or hired developer can build a custom application against the permitted APIs (external code). Creating item records does not establish exportable native restaurant workflows or independent execution of POS business logic. | Lightspeed Restaurant K-Series custom integrations ↗Paid add-on; one-business use; Financial and Items APIs; excluded APIs and RTN/webhooks; polling and OAuth client provisioningChecked 2026-10-17 Lightspeed Restaurant K-Series create an item ↗POST /items/v1/items; OAuth items scope; item name, location, SKU, accounting group and price; 201 responseChecked 2026-10-17 |
| What rights or portability are documented for custom workflow artifacts? | -Lightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events. The reviewed K-Series API scope and integration guide do not establish ownership, reusable export or independent execution rights for native POS workflow definitions. API client development is a separate artifact. | Lightspeed Restaurant K-Series custom integrations ↗Paid add-on; one-business use; Financial and Items APIs; excluded APIs and RTN/webhooks; polling and OAuth client provisioningChecked 2026-10-17 Lightspeed Restaurant K-Series API documentation ↗K-Series product scope; Financial and Items API families and OAuth scopes; distinct Orders APIChecked 2026-10-17 |
| What usable data or native definitions can leave before cancellation? | Portable structured records on documented routes; whole-product completeness unverifiedLightspeed Restaurant K-Series custom integrations: Financial API sales records and Items API catalog reads/writes for one approved restaurant business and its locations. Excludes Retail, Restaurant L-Series, orders-api, reservations, property-management interfaces and partner-only real-time events. Sales and catalog responses preserve financial receipt/item identities and structured fields for scoped migration. They do not establish a restorable restaurant database, all documents, complete edit history or export of every POS workflow and configuration. | Lightspeed Restaurant K-Series retrieve financial sales ↗GET /f/v2/business-location/{businessLocationId}/sales; from/to, max 365-day window, pageSize and nextPageToken; financial record fieldsChecked 2026-10-17 Lightspeed Restaurant K-Series retrieve items ↗GET /items/v1/items; businessLocationId, offset/amount, SKU/name filters, item IDs and active stateChecked 2026-10-17 |
SOURCES / SCOPE / HISTORY
Sources and open questions
This review is based on the documentation below. Live account behavior and customer-specific agreements haven’t been tested.
Still to confirm
- Applicable downstream processing, AI-use and redistribution rights
- Contractual post-cancellation retrieval terms
- Native workflow artifact ownership, reusable export and independent execution
Documentation
Assessment checked 2026-10-17. Each answer retains its source and applicable route; the check date does not establish live account behavior.