Linking Lightspeed Retail as a source

Alpha release

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

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

Community questions

Was this page useful?

Questions about this page? or post a community question.