> AI agents: this is one page from PostHog's docs. Full index of Markdown docs for LLMs: https://posthog.com/llms.txt

# Linking Lightspeed Retail as a source

Canonical URL: https://posthog.com/docs/data-pipelines/sources/lightspeed-retail

> **Cloud region:** This page uses US Cloud hosts. For an EU Cloud project, use `https://eu.posthog.com` instead of `https://us.posthog.com` or `https://app.posthog.com` (app host for links).

## On this page

- [Prerequisites](#prerequisites)
- [Adding a data source](#adding-a-data-source)
- [Available tables](#available-tables)
- [Sync mode](#sync-mode)
- [Configuration](#configuration)
- [Supported tables](#supported-tables)

**Beta release**

This source is currently in **beta**. It works end to end, but you may still hit rough edges. [Let us know](https://us.posthog.com/#panel=support%3Asupport%3Adata_warehouse%3A%3Atrue) if you do.

![](https://res.cloudinary.com/dmukukwp6/image/upload/texture_tan_9608fcca70)

![](https://res.cloudinary.com/dmukukwp6/image/upload/texture_tan_dark_a92b0e022d)

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.

`npx @posthog/wizard warehouse`

![PostHog Wizard hedgehog](https://res.cloudinary.com/dmukukwp6/image/upload/wizard_3f8bb7a240.png)

![](https://res.cloudinary.com/dmukukwp6/image/upload/wizard_3f8bb7a240.png)Let AI connect your sources for you

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](https://app.posthog.com/data-management/sources) 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

| Table | Description | Sync method |
| --- | --- | --- |
| `sales` | Sales transactions | Incremental |
| `customers` | Customer records | Incremental |
| `products` | Product catalog | Incremental |
| `inventory` | Inventory records | Incremental |
| `outlets` | Store outlet locations | Incremental |
| `registers` | Register devices | Incremental |
| `users` | Staff user accounts | Incremental |
| `taxes` | Tax configurations | Incremental |

**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

| Option | Type | Required |
| --- | --- | --- |
| `Domain prefix` | text | Yes |
| `Personal token` | password | Yes |

## Supported tables

| Table | Description | Sync method | Incremental field | Primary key |
| --- | --- | --- | --- | --- |
| `sales` | A point-of-sale transaction (a register sale) in Lightspeed Retail. | Incremental, Full refresh | version | — |
| `customers` | A customer record in Lightspeed Retail. | Incremental, Full refresh | version | — |
| `products` | A product in the Lightspeed Retail catalog. | Incremental, Full refresh | version | — |
| `inventory` | Per-outlet stock levels for a product in Lightspeed Retail. | Incremental, Full refresh | version | — |
| `outlets` | A physical store location (outlet) in Lightspeed Retail. | Incremental, Full refresh | version | — |
| `registers` | A point-of-sale register (till) at an outlet in Lightspeed Retail. | Incremental, Full refresh | version | — |
| `users` | A staff user account in Lightspeed Retail. | Incremental, Full refresh | version | — |
| `taxes` | A sales tax rate configured in Lightspeed Retail. | Incremental, Full refresh | version | — |
| `consignments` | An inventory movement in Lightspeed Retail: a supplier order, outlet transfer, stocktake or supplier return. | Incremental, Full refresh | version | — |
| `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 refresh | version | — |
| `payment_types` | A payment type (e.g. cash, card, gift card) configured in Lightspeed Retail. | Incremental, Full refresh | version | — |
| `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 refresh | version | — |
| `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 | — | — |
| `brands` | A product brand in Lightspeed Retail. Products reference it through brand\_id. | Incremental, Full refresh | version | — |
| `customer_groups` | A customer group in Lightspeed Retail. Customers reference it through customer\_group\_id. | Incremental, Full refresh | version | — |
| `shifts` | A staff shift in Lightspeed Retail: the time a user clocked in and out. | Incremental, Full refresh | version | — |
| `store_credits` | The store credit account of a Lightspeed Retail customer, with its balance and transactions. | Full refresh | — | — |
| `store_credit_transactions` | A store credit transaction of a Lightspeed Retail customer, such as an issue or a redemption. | Full refresh | — | — |