Supergood | Lightspeed POS API
Programmatically access Lightspeed POS product catalogs, inventory, customer profiles, and sales with a stable REST API. Supergood builds and operates production-grade, unofficial Lightspeed integrations so your team can automate retail and restaurant workflows without heavy custom engineering.
Plain English: Lightspeed POS is cloud-based point of sale software for retail stores, restaurants, and golf operations. An unofficial API lets you programmatically pull products and variants, stock levels by location, suppliers, customers and loyalty balances, sales and refunds, payments and shifts—and push updates like stock adjustments, purchase orders, menu changes, and new customers back into Lightspeed.
For a tech company integrating with Lightspeed, this means you can ingest real-time catalog and sales data to power analytics, sync orders and inventory with your e-commerce platform, automate purchasing and receiving, reconcile payments to accounting (e.g., QuickBooks, Xero), and enrich your CRM with unified customer and loyalty records. You can also drive restaurant flows (menus, modifiers, open checks), trigger targeted promotions, and keep downstream systems (ERP, warehouse, analytics, marketing) in lockstep.
What is Lightspeed POS?
Lightspeed POS (https://www.lightspeedhq.com/) is a cloud platform for retail and hospitality that combines point of sale, inventory, purchasing, e-commerce, payments, and analytics across single- and multi-location businesses. Teams use Lightspeed to run registers, manage product catalogs and menus, track stock and transfers, process sales and refunds, manage customers and loyalty, create purchase orders and receive stock, and reconcile payments.
Core product areas include:
- Retail POS & Catalog (Products, Variants/SKUs, Barcodes, Categories, Tags)
- Restaurant POS (Menus, Modifiers, Tables, Courses, Kitchen/Bar routing)
- Inventory & Purchasing (Stock Levels, Transfers, Suppliers, Purchase Orders, Receiving, Costing)
- Commerce & Payments (In-Store, Online Ordering, Card Present/Not Present, Gift Cards, Discounts)
- Customers & Loyalty (Profiles, Groups, Points/Balances, Marketing)
- Analytics & Reporting (Sales, Margins, Inventory Performance, Shifts)
Common data entities:
- Accounts, Locations, Registers, Users/Roles/Permissions
- Products, Variants, SKUs, Barcodes, Categories, Tags
- Suppliers/Vendors, Catalog Imports, Price Books
- Stock Levels by Location, Stock Movements/Adjustments, Transfers
- Purchase Orders, Receiving, Invoices/Bills
- Customers, Loyalty Balances, Customer Groups, Store Credit, Gift Cards
- Sales/Tickets, Line Items, Taxes, Discounts/Promotions, Payments/Refunds, Shifts/Tills
- Restaurant Menus, Menu Items, Modifiers, Combos, Tables/Checks
- Taxes/Tax Classes, Rounding Rules, Service Charges
The Lightspeed POS Integration Challenge
Retailers and restaurants rely on Lightspeed daily, but turning POS-centric workflows into API-driven automation is non-trivial:
- Multiple product lines: Different modules (Retail vs. Restaurant; legacy R-Series vs. X-Series) with distinct schemas and behaviors
- Complex inventory: Multi-location stock, variants/SKUs, unit conversions, transfers, and backordered receiving
- Financial nuance: Split tenders, tips, taxes by jurisdiction, service charges, gift cards, and store credit
- Role-aware access: Cashier vs. manager permissions, restricted cost/pricing visibility
- API friction: Paywalled API access, rate limits, limited webhooks, and inconsistent export fields by module
- Front-end-first flows: Menu management, table service, and loyalty workflows optimized for UI, not headless automation
How Supergood Creates Lightspeed POS APIs
Supergood reverse-engineers authenticated browser flows and network interactions to deliver a resilient API endpoint layer for your Lightspeed tenant.
- Handles username/password, SSO/OAuth, and MFA (SMS, email, TOTP) securely
- Maintains session continuity with automated refresh and change detection
- Normalizes responses so you can integrate once and rely on consistent objects across retail and restaurant modules
- Aligns with customer entitlements and role-based permissions to ensure compliant access
Use Cases
Retail, Restaurant, and Customer Data Sync
- Mirror products, variants, customers, loyalty balances, and suppliers into your internal systems
- Keep multi-location stock levels current for analytics and replenishment
- Normalize categories, tax classes, and status flags across stores and markets
Inventory & Catalog Automation
- Push catalog updates and price changes at scale (including variants and barcodes)
- Automate stock adjustments from warehouse/WMS or IoT counters
- Create purchase orders from demand forecasts and auto-receive against ASN data
Omnichannel Orders & Payments
- Sync online orders and in-store sales to a unified ledger
- Reconcile split tenders, tips, taxes, and gift card redemptions to accounting (e.g., QuickBooks, Xero)
- Trigger loyalty accruals/redemptions and targeted promotions based on purchase triggers
Restaurant Menus & Service
- Synchronize menus and modifiers from your CMS to Lightspeed Restaurant
- Ingest open checks, fire items to kitchen, and automate 86’ing out-of-stock items
- Drive guest experience updates across online ordering and in-venue displays
Available Endpoints
Authentication
POST /sessions: Establish a session using credentials. Supergood manages MFA (SMS, email, TOTP) and SSO/OAuth when enabled. Returns a short-lived auth token maintained by the platform.
curl --request POST \
--url https://api.supergood.ai/integrations/<integration_id>/sessions \
--header 'Authorization: Basic <Base64 encoded token>' \
--header 'Content-Type: application/json' \
--data '{
"username": "[email protected]",
"password": "<password>",
"mfa": { "type": "totp", "code": "123456" }
}'
Example response
{
"authToken": "eyJhbGciOi...",
"expiresIn": 3600,
"user": {
"id": "u_ls_82c19a",
"name": "Store Manager",
"entitlements": ["products", "inventory", "sales", "customers"]
}
}
POST /sessions/refresh: Refresh an existing token to keep sessions uninterrupted.
Products
GET /products: List products with variants, pricing, and optional per-location stock summaries.
Query parameters
- locationId: string
- supplierId: string
- categoryId: string
- active: true | false
- updatedFrom, updatedTo: ISO 8601 timestamps
- page, pageSize: integers for pagination
Example response
{
"items": [
{
"productId": "prd_9f21b7",
"name": "Classic Tee",
"description": "100% cotton crew neck",
"category": "Apparel > Tops",
"supplierId": "sup_4a10cc",
"taxClass": "standard",
"active": true,
"tags": ["summer", "unisex"],
"variants": [
{
"variantId": "var_bk_s",
"sku": "TEE-BLK-S",
"barcode": "190000001234",
"optionValues": {"color": "Black", "size": "S"},
"price": 19.99,
"cost": 7.10,
"active": true
},
{
"variantId": "var_bk_m",
"sku": "TEE-BLK-M",
"barcode": "190000001235",
"optionValues": {"color": "Black", "size": "M"},
"price": 19.99,
"cost": 7.10,
"active": true
}
],
"stockByLocation": [
{"locationId": "loc_downtown", "onHand": 42, "available": 40, "reorderPoint": 10, "reorderQty": 20, "updatedAt": "2026-01-20T13:45:00Z"}
],
"updatedAt": "2026-01-20T13:45:00Z"
}
],
"page": 1,
"pageSize": 50,
"total": 1
}
Inventory
PATCH /inventory/levels: Adjust stock levels in bulk by location with idempotency.
curl --request PATCH \
--url https://api.supergood.ai/integrations/<integration_id>/inventory/levels \
--header 'Authorization: Bearer <authToken>' \
--header 'Idempotency-Key: 9b2c2c74-1a68-4c79-9a7e-1a0a1e9d3f77' \
--header 'Content-Type: application/json' \
--data '{
"locationId": "loc_downtown",
"reason": "cycle_count",
"referenceId": "wms-cc-2026-01-21",
"items": [
{"sku": "TEE-BLK-S", "adjustmentType": "set", "quantity": 40},
{"sku": "TEE-BLK-M", "adjustmentType": "increment", "quantity": 5}
]
}'
Example response
{
"locationId": "loc_downtown",
"results": [
{"sku": "TEE-BLK-S", "onHand": 40, "available": 38, "status": "updated"},
{"sku": "TEE-BLK-M", "onHand": 47, "available": 45, "status": "updated"}
],
"processedAt": "2026-01-21T10:12:09Z"
}
Sales
POST /sales: Create a sale with line items, taxes/discounts, and payment tenders.
curl --request POST \
--url https://api.supergood.ai/integrations/<integration_id>/sales \
--header 'Authorization: Bearer <authToken>' \
--header 'Content-Type: application/json' \
--data '{
"locationId": "loc_downtown",
"registerId": "reg_03",
"employeeId": "emp_8821",
"customerId": "cus_51b9f2",
"referenceId": "web-ord-78342",
"lineItems": [
{"sku": "TEE-BLK-M", "description": "Classic Tee Black M", "quantity": 2, "unitPrice": 19.99, "discount": {"type": "percent", "value": 10}, "taxCode": "standard"},
{"sku": "HAT-GRY-OS", "description": "Dad Hat Grey", "quantity": 1, "unitPrice": 24.00, "taxCode": "standard"}
],
"totals": {"subtotal": 59.98, "discountTotal": 4.00, "taxTotal": 5.12, "grandTotal": 61.10},
"payments": [
{"method": "card", "amount": 61.10, "tipAmount": 0.00, "card": {"token": "tok_visa_...", "last4": "4242", "brand": "visa"}}
]
}'
Example response
{
"saleId": "sal_f1a0c9",
"receiptNumber": "R-00018273",
"status": "completed",
"customerId": "cus_51b9f2",
"locationId": "loc_downtown",
"totals": {"subtotal": 59.98, "discountTotal": 4.00, "taxTotal": 5.12, "grandTotal": 61.10},
"payments": [{"method": "card", "amount": 61.10, "authCode": "A1B2C3"}],
"createdAt": "2026-01-21T11:20:44Z"
}
Technical Specifications
- Authentication: Username/password with MFA (SMS, email, TOTP) and SSO/OAuth where enabled; supports service accounts or customer-managed credentials
- Response format: JSON with consistent resource schemas and pagination across modules
- Rate limits: Tuned for enterprise throughput while honoring customer entitlements and usage controls
- Session management: Automatic reauth and cookie/session rotation with health checks
- Data freshness: Near real-time retrieval of products, inventory, customers, and sales
- Security: Encrypted transport, scoped tokens, and audit logging; respects Lightspeed role-based permissions
- Webhooks: Optional asynchronous delivery for long-running workflows (e.g., PO receiving, end-of-day close)
Performance Characteristics
- Latency: Sub-second responses for list/detail queries under normal load
- Throughput: Designed for high-volume catalog sync, stock adjustments, and sales ingestion
- Reliability: Retry logic, backoff, and idempotency keys minimize duplicate actions
- Adaptation: Continuous monitoring for UI/API changes with rapid adapter updates
Getting Started
- Schedule Integration Assessment
Book a 30-minute session to confirm your modules, licensing, and authentication model.
- Supergood Builds and Validates Your API
We deliver a hardened Lightspeed adapter tailored to your workflows and entitlements.
- Deploy with Monitoring
Go live with continuous monitoring and automatic adjustments as Lightspeed evolves.
Frequently Asked Questions
Q: Which Lightspeed modules can this integration cover?
Supergood supports workflows across commonly used modules such as Retail (products, variants, stock, customers, sales), Restaurant (menus, modifiers, checks), and Purchasing (suppliers, POs, receiving), subject to your licensing and entitlements. We scope coverage during integration assessment.
Q: How are MFA and SSO handled for automation?
We support username/password + MFA (SMS, email, TOTP) and can operate behind SSO/OAuth when enabled. Sessions are refreshed automatically with secure challenge handling.
Q: Can you sync sales and payments to our accounting system?
Yes. We normalize sales, taxes, tips, discounts, and tenders for ERP/accounting (e.g., QuickBooks, Xero) and deliver updates via webhooks or polling while complying with rate and permission constraints.
Q: Do you handle gift cards, loyalty, and multi-location stock?
Yes. We model gift card issuance/redemption, loyalty accruals/redemptions, and per-location stock with transfers and adjustments—aligned to your store configuration and permissions.
Related Integrations
Intralinks API - Programmatically access the Intralinks VDR with Supergood
Ready to automate your Lightspeed workflows?
Supergood can have your Lightspeed integration live in days with no ongoing engineering maintenance.
