Linking Lightspeed Retail as a source

Alpha release

This source is currently in alpha. The interface and available tables may change.

Let AI connect your sources for you

Skip the manual setup — run this in your project and the wizard auto-detects your databases and APIs and connects them to PostHog.

Learn more
PostHog Wizard hedgehog

Sync your Lightspeed Retail (X-Series) point-of-sale data – sales, customers, products, inventory, and more – into the PostHog data warehouse.

Prerequisites

  • A Lightspeed Retail (X-Series) account on the Plus plan or above.
  • Admin access to create a personal token in Lightspeed under Setup > Personal Tokens.

Adding a data source

  1. Go to the sources tab of the data pipeline section in PostHog.
  2. Click + New source and then click Link next to Lightspeed Retail.
  3. Enter your Lightspeed Retail credentials:
    • Domain prefix – the subdomain of your store URL. For example, if your store is at mystore.retail.lightspeed.app, enter mystore. You can also paste the full URL and PostHog normalizes it automatically.
    • Personal token – create one in Lightspeed under Setup > Personal Tokens. This requires admin access and a Plus plan or above.
  4. Click Next.
  5. Select the tables you want to sync, set the sync method and frequency, then click Import.

Once the syncs are complete, you can start using Lightspeed Retail data in PostHog.

Available tables

TableDescriptionSync method
salesSales transactionsIncremental
customersCustomer recordsIncremental
productsProduct catalogIncremental
inventoryInventory recordsIncremental
outletsStore outlet locationsIncremental
registersRegister devicesIncremental
usersStaff user accountsIncremental
taxesTax configurationsIncremental

Incremental tables sync only new or updated records on each run.

Sync mode

All tables support incremental sync using the version field. Every record in the Lightspeed X-Series API carries a monotonically increasing integer version. PostHog uses this as a cursor to fetch only records that changed since the last sync, so subsequent syncs are fast and efficient.

Configuration

OptionTypeRequired
Domain prefixtextYes
Personal tokenpasswordYes

Supported tables

TableDescriptionSync methodIncremental fieldPrimary key
sales

A point-of-sale transaction (a register sale) in Lightspeed Retail.

Incremental, Full refreshversion—
customers

A customer record in Lightspeed Retail.

Incremental, Full refreshversion—
products

A product in the Lightspeed Retail catalog.

Incremental, Full refreshversion—
inventory

Per-outlet stock levels for a product in Lightspeed Retail.

Incremental, Full refreshversion—
outlets

A physical store location (outlet) in Lightspeed Retail.

Incremental, Full refreshversion—
registers

A point-of-sale register (till) at an outlet in Lightspeed Retail.

Incremental, Full refreshversion—
users

A staff user account in Lightspeed Retail.

Incremental, Full refreshversion—
taxes

A sales tax rate configured in Lightspeed Retail.

Incremental, Full refreshversion—
consignments

An inventory movement in Lightspeed Retail: a supplier order, outlet transfer, stocktake or supplier return.

Incremental, Full refreshversion—
consignment_products

A product line item on a Lightspeed Retail consignment, with the expected and received counts.

Full refresh——
suppliers

A supplier that products are ordered from in Lightspeed Retail.

Incremental, Full refreshversion—
payment_types

A payment type (e.g. cash, card, gift card) configured in Lightspeed Retail.

Incremental, Full refreshversion—
product_categories

A product category in the Lightspeed Retail category hierarchy.

Full refresh——
stock_adjustments

A manual stock adjustment for a product at an outlet in Lightspeed Retail, e.g. damage, theft or stock found.

Incremental, Full refreshversion—
promotions

A promotion in Lightspeed Retail: the rules and discount applied to the products it covers.

Full refresh——
promo_codes

A promo code that unlocks a Lightspeed Retail promotion.

Full refresh——
gift_cards

A Lightspeed Retail gift card with its balance and transaction history.

Full refresh——
gift_card_transactions

A transaction on a Lightspeed Retail gift card, such as an activation, redemption or reload.

Full refresh——

Still have questions?

Was this page useful?