In this guide, you'll learn how to set up Lightspeed Retail (X Series) as a source in Flxpoint, from creating the source wizard to activating inventory and fulfillment operations. With this connection you'll keep stock and pricing synchronized and place fulfillment requests as register sales through Lightspeed.
Add Source and Establish Connection
Choose the right Source Type
Lightspeed Retail (X Series) is a cloud-based POS and retail management platform. Choose the Source Type that best matches how you use Lightspeed in your supply chain.
- Vendor Warehouse (Recommended): You send POs/FRs to Lightspeed so they ship directly to your customers.
- Internal Warehouse: You stock items and ship from your own facility.
- External Warehouse: A 3PL or external partner ships your owned inventory.
- Product Data Source: Content-only source to enrich product details (no fulfillment).
- Yes (Recommended): You can route orders here.
- No: Routing/Shipping steps won't apply.
- Override: Auto Processing (Use Global / Auto Process / Do NOT Auto Process).
- Commit Stock + Inventory Management Options.
- Allow Backorders / Cancel Unacknowledged Items.
- Yes, Use Rate Shopping (Real-Time Estimates).
- No, Set Up via Rules.
Finish the Source Wizard by confirming your Ship From location and reviewing shipping behavior for Lightspeed.
- Skip if you do not need to configure shipping methods at this time.
- Or Add Method to configure shipping methods if required for your setup.
- Address, City, State/Code, Postal Code, Country/Code
- Optional: Contact Name, Phone, Email
Lightspeed Retail (X Series) uses a single API connection for all operations — inventory retrieval and fulfillment requests. You will create one connection using your store's Domain Prefix and Personal Token.
- Connection Name (required) — a friendly label for this connection
- Domain Prefix (required) — your store domain prefix (the XXX part from your Lightspeed URL). Do not include https:// or .retail.lightspeed.app
- Personal Token (required) — a unique API key to connect your store. Click Find my credentials in the connection dialog to generate one
https://mystore.retail.lightspeed.app/, your Domain
Prefix is mystore.
- This single connection powers all Lightspeed operations: Get Inventory [Primary], Get Inventory [Secondary], and Send Fulfillment Requests.
Product & Order Operations
Get Inventory (Primary)
Lightspeed Retail (X Series) integration: Supported
Lightspeed Retail (X Series) is a cloud-based point-of-sale and retail management platform. The Get Inventory (Primary) job imports Lightspeed product data and quantities into your Global Inventory Pool via API connection.
Use GIP to keep Lightspeed inventory current in Flxpoint: import the full product catalog with core details (names, descriptions, categories, brands, images, weight, dimensions), keep quantities and pricing up to date, and manage archived/unarchived stock status.
The sections below walk through each step of the setup and configuration process.
Each run follows this workflow:
- 1Select Connection — Choose your Lightspeed Retail (X Series) connection.
- 2Fetch Data — Flxpoint retrieves inventory data from Lightspeed including product details, quantities, and pricing.
- 3Map Fields — Incoming data is matched to your Mapping Template.
- 4Save to Global Inventory Pool — The pool is updated; changes flow to channels after your next push.
Follow these steps in your Lightspeed source → Get Inventory (Primary):
Choose Lightspeed and create or select your connection.
Tip: Use Test ConnectionValidates credentials before you save. to validate your credentials.
- Archive/Un-Archive Inventory — Toggle to enable automatic archiving of inventory not found in the source feed (quantity set to zero). Inventory re-added later will be un-archived. We recommend not enabling this if it is already enabled on Get Inventory [Secondary].
Use the recommended fields from the Mapping Utilities section below, then adjust for your catalog.
Run manually or enable a schedule (jobs run in UTC). The status page will show Connected, Configured, and Mapped with the template once complete.
Starter field mapping for Lightspeed (adjust per your template):
| Flxpoint Field | Lightspeed Field | Example | Purpose | Status |
|---|---|---|---|---|
| SKU (T) | Lightspeed X Series Product: Sku | [Example] | Product identifier | Required |
| Title (T) | Lightspeed X Series Product: Name | [Example] | Display title | Required |
| Description (T) | Lightspeed X Series Product: Description | [Example] | Short description | Optional |
| Brand (T) | Lightspeed X Series Product: Brand | [Example] | Brand | Optional |
| Cost (N) | Lightspeed X Series Product: Supply Price | [Example] | Cost price | Optional |
| MSRP (N) | Lightspeed X Series Product: Price Including Tax | [Example] | Retail price | Optional |
| Quantity (N) | Lightspeed X Series Product: Quantity | [Example] | Stock quantity | Optional |
| Weight (N) | Lightspeed X Series Product: Weight | [Example] | Product weight | Optional |
| Weight Unit (T) | Lightspeed X Series Product: Weight Unit | pound | Unit of weight | Optional |
| Height (N) | Lightspeed X Series Product: Height | [Example] | Height | Optional |
| Length (N) | Lightspeed X Series Product: Length | [Example] | Length | Optional |
| Width (N) | Lightspeed X Series Product: Width | [Example] | Width | Optional |
| Image (T) | Lightspeed X Series Product: (via All Images) | https://... | Product image URL | Optional |
| Primary Category (T) | Lightspeed X Series Product: Category 1 | [Example] | Main category | Optional |
| Sub Category (T) | Lightspeed X Series Product: Category 2 | [Example] | Subcategory | Optional |
| Parent SKU (T) | Lightspeed X Series Product: Parent Sku | [Example] | Parent SKU for variants | Optional |
Lightspeed X Series Product: Brand (T), Category 1 (T), Category 2 (T), Category 3 (T), Description (T), Dimension Unit (T), Height (N), Id (T), Length (N), Loyalty Amount (N), Name (T), Parent Sku (T), Price Excluding Tax (N), Price Including Tax (N), Quantity (N), Sku (T), Source (T), Supply Price (N), Variant Name (T), Weight (N), Weight Unit (T), Width (N).
- Match It — Directly map a source field to a Flxpoint field.
- Set It — Set a fixed/static value for a field.
- Transform It (Mapping Set) — Apply a transformation or mapping set to the value.
- Smart Rules — Use conditional logic to determine the mapped value.
- Skip It (Don't Map) — Ignore the field entirely.
- Skip It (Set to Empty) — Clear the field value on each sync.
- Connection shows Connected and passes Test Connection.
- Mapping template is selected and saved.
- Lightspeed credentials (Domain Prefix, Personal Token) are confirmed.
- Archive/Un-Archive setting is reviewed.
- Data Not Importing: Verify Lightspeed credentials. Ensure the connection passes Test Connection.
- Images Not Loading: Confirm product images exist in Lightspeed. Check that image fields are mapped correctly using the All Images mapping option.
- Fields Not Mapping: Ensure the desired fields are enabled in the Mapping Dashboard and that the mapping template is saved and selected.
- Archived products still showing? If Archive/Un-Archive Inventory is enabled, products removed from the feed are set to quantity zero but remain in the pool. Disable the setting or manually remove archived items if needed.
| Feature | Availability | What to Expect |
|---|---|---|
| Custom Fields | Supported | 100 custom fields, 10 summary fields. |
| Variations / Options | Supported | Option Name/Value 1-10. |
| Quantity | Supported | From Lightspeed. |
| Weights & Dimensions | Supported | Weight, Height, Length, Width. |
| Images | Supported | Via API (All Images mapping). |
| Categories | Supported | Two-level (Primary + Sub). |
| Weight Unit Options | Supported | pound, ounce, gram, kilogram (full name) or lb, oz (abbreviated). |
Get Inventory (Secondary)
Lightspeed Retail (X Series) integration: Supported
The Lightspeed Retail (X Series) – Get Inventory (Secondary) integration retrieves secondary inventory data from Lightspeed, focusing on variant-level Quantity updates. This job uses the same API connection configured during primary inventory setup.
The sections below walk through each step of the setup and configuration process.
Use this job to:
- Refresh variant-level quantity for existing SKUs.
- Keep stock levels in sync between Lightspeed and Flxpoint.
Each run follows this workflow:
- 1Connection — Uses the existing Lightspeed connection to retrieve secondary inventory data.
- 2Parse & Map — The Inventory Level field from Lightspeed is mapped to Quantity in Flxpoint. Mapping targets the fields listed in the Mapping Utilities section below.
- 3Write — Updates variant data in the Global Inventory Pool.
LS-12345 has inventory level
50 in Lightspeed ⇒ Flxpoint updates the variant
quantity to 50.
Choose Lightspeed Retail (X Series) and select the existing API connection configured during primary inventory setup.
- Archive/Un-Archive Inventory — Same toggle as Primary. Inventory not found in the source feed will be archived (quantity set to zero). We recommend not enabling on both Primary and Secondary.
- Allow Create Variant (Advanced Settings) — Toggle to allow creating new variants during the Secondary inventory sync. Set to No unless you expect new variants to appear between Primary runs.
Choose or create a mapping template named Lightspeed Retail (X Series) – Get Inventory [Secondary]. Use the recommended fields from the Mapping Utilities section below.
Run manually or enable scheduling (jobs run in UTC). When ready, the status page will show Connected, Configured, and Mapped with your template.
Map the variant-level field below for secondary inventory updates. For Lightspeed, Secondary focuses on quantity sync.
| Flxpoint Field | Lightspeed Field | Example | Purpose | Status |
|---|---|---|---|---|
| Quantity (N) | Lightspeed X Series Inventory: Inventory Level | 50 |
Stock quantity | Required |
Lightspeed X Series Inventory: Inventory Level (N).
Options include Field, Value, Mapping Set, Rules, Don't Map, Set to Empty.
- Connection reuses the same Lightspeed connection from Get Inventory (Primary) and shows Connected.
- Mapping template is selected and saved.
- Archive/Un-Archive and Allow Create Variant settings are reviewed.
- Data not importing? Verify Lightspeed credentials. Use Test Connection to confirm the connection is active.
- Fields not mapping? Check the Mapping Dashboard to confirm the Quantity field is mapped to Lightspeed X Series Inventory: Inventory Level.
- Missing quantities? Confirm that inventory levels exist for the target products in Lightspeed.
| Feature | Availability | What to Expect |
|---|---|---|
| Variant-Level Fields | Supported | Quantity (via Inventory Level). |
| Allow Create Variant | Supported | Enable to create new variants during secondary sync. |
| Connection | Shared | Reuses the same Lightspeed Retail (X Series) API connection from primary. |
| Scheduling | Supported | Run on demand or via recurring schedule (UTC). |
| Catalog-Level Fields | Not Supported | Titles, images, and descriptions belong in the Primary job. |
Send Fulfillment Requests
Lightspeed Retail (X Series) integration: Supported
The Lightspeed Retail (X Series) – Send Fulfillment Requests integration sends Flxpoint Fulfillment Requests (FRs) to Lightspeed as Register Sales via the API connection. This uses the same Lightspeed Retail (X Series) connection configured during setup.
Configuration involves selecting the API connection, providing your Lightspeed Register ID, User ID, and Tax ID, and creating a mapping template that maps Flxpoint FR fields to Lightspeed's register sale format.
The sections below walk through each step of the setup and configuration process.
The Send Fulfillment Requests integration converts Flxpoint FRs into Lightspeed Register Sales via API. If no error is received during submission, the FR is marked as processed.
The setup is completed in four steps.
Select Lightspeed Retail (X Series) and choose your existing API connection.
Click Test Connection, then Save Connection once successful.
- Register ID * (required) — The valid ID of the register in Lightspeed to assign the sale to.
- User ID * (required) — The valid ID of a Lightspeed Retail (X-Series) user to associate with the sale.
- Tax ID * (required) — The tax configuration ID for the sale.
Expand Advanced Settings if needed:
- Hold for X hours — Temporarily hold FRs before sending (useful for manual review).
- Only Send During Business Hours — Restrict sends to business hours only.
Click Save and Proceed.
Choose or create a mapping template named Lightspeed Retail (X Series) – Send FRs. Click Save and Complete.
Run on demand or enable scheduling. Schedules run in UTC. The status page will show Connected, Configured, and Mapped.
The Mapping Template defines how Flxpoint fulfillment request data maps to Lightspeed's register sale schema.
| Flxpoint Field | Lightspeed Field | Purpose | Status |
|---|---|---|---|
| Customer Fields | |||
| First Name (T) | Customer: First Name | Customer first name | Required |
| Last Name (T) | Customer: Last Name | Customer last name | Required |
| Email (T) | Customer: Email | Customer email | Optional |
| Phone (T) | Customer: Phone | Customer phone | Optional |
| Company Name (T) | Customer: Company Name | Company name | Optional |
| Physical Address 1 (T) | Customer: Physical Address 1 | Shipping address line 1 | Required |
| Physical Address 2 (T) | Customer: Physical Address 2 | Shipping address line 2 | Optional |
| Physical City (T) | Customer: Physical City | Shipping city | Required |
| Physical State (T) | Customer: Physical State | Shipping state | Required |
| Physical Postcode (T) | Customer: Physical Postcode | Shipping postal code | Required |
| Physical Country Id (T) | Customer: Physical Country Id | Shipping country | Required |
| Register Sale Fields | |||
| Note (T) | Register Sale: Note | Order notes | Optional |
| Source Id (T) | Register Sale: Source Id | Source identifier | Optional |
| Status (T) | Register Sale: Status | Sale status | Optional |
| Register Sale Item Fields | |||
| Price (N) | Register Sale Item: Price | Item price | Required |
| Quantity (N) | Register Sale Item: Quantity | Order quantity | Required |
| Tax (N) | Register Sale Item: Tax | Item tax | Optional |
| Adjustments Fields | |||
| Total Discount (N) | Adjustments: Total Discount | Order discount | Optional |
| Total Shipping Cost (N) | Adjustments: Total Shipping Cost | Shipping cost | Optional |
| Total Tax (N) | Adjustments: Total Tax | Tax amount | Optional |
The following field categories are available from Flxpoint:
- Billing Address: Address Line 1, Address Line 2, City, Company Name, Country, Country Code, Email, First Name, Full Name, Last Name, Phone, Postal Code, State.
- Fulfillment Request: Fulfillment Request Number, Payment Method.
- FR Item: SKU, Quantity, Unit Price.
- Shipping Address: Address Line 1, Address Line 2, Address Line 3, City, Company Name, Country, Country Code, Email, First Name, Full Name, Last Name, Phone, Postal Code, State.
- Source Shipping Method: Method.
- Connection shows Connected and passes Test Connection.
- Mapping template is selected and saved.
- Register ID, User ID, and Tax ID are filled in.
- Request not sending? Verify Lightspeed credentials and confirm the connection passes Test Connection.
- Fields not mapping? Check the Mapping Dashboard to confirm all required fields are mapped correctly. Ensure Ship To address fields, SKU, and Quantity are present.
- Order rejection? Confirm the Register ID, User ID, and Tax ID are valid Lightspeed values. Check the integration logs for specific error messages.
- Address validation errors? Ensure Physical Address fields (Address 1, City, State, Postcode, Country Id) are properly mapped from Flxpoint shipping address fields.
| Feature | Availability | What to Expect |
|---|---|---|
| Fulfillment Request Number | Supported | FR number is mappable. |
| Ship To Address | Supported | Full address including Address Lines, City, State, Postal Code, Country. |
| Shipping Method | Supported | Lightspeed uses Customer physical/postal address fields for delivery. |
| Register Sale | Supported | FRs are sent as Register Sales to Lightspeed. |
| FR Item Association | Supported | Line items include SKU and Quantity. |
| Custom Fields | Supported | Up to 4 custom fields available on the Customer object. |
Troubleshooting Common Errors
Common issues and solutions for Lightspeed integration. Expand each item to learn more.
What's happening
Get Inventory (Primary) is not importing product data from Lightspeed, or the connection test fails.
- Lightspeed credentials (Domain Prefix, Personal Token) may be incorrect or expired.
- The Lightspeed API may be temporarily unavailable.
- Archive/Un-Archive Inventory setting may need adjustment.
How to fix it
- Navigate to the Get Inventory (Primary) connection and click Test Connection to verify credentials.
- Confirm the Domain Prefix and Personal Token are correct.
- Check the Archive/Un-Archive Inventory setting if products are unexpectedly archived.
- If the connection was working before, confirm access is still active on the Lightspeed side.
What's happening
Products that were removed from Lightspeed are still visible in Flxpoint, or quantity updates are not reflecting the latest inventory levels.
- If Archive/Un-Archive Inventory is enabled, removed products are set to quantity zero but remain in the pool.
- The Get Inventory (Secondary) job may not be running or the Inventory Level field may not be mapped.
How to fix it
- Review the Archive/Un-Archive setting — disable it if you want removed products to stay active, or manually remove archived items.
- Confirm Get Inventory (Secondary) is scheduled and that Quantity is mapped to Lightspeed X Series Inventory: Inventory Level.
- Run the integration manually and check the logs for errors.
What's happening
Quantity is not updating after running Get Inventory (Secondary).
- The mapping template may not have Quantity mapped to Lightspeed X Series Inventory: Inventory Level.
- The Allow Create Variant setting may need to be enabled if new variants are expected.
- The Lightspeed connection may need to be verified.
How to fix it
- Open the Get Inventory (Secondary) mapping template and confirm Quantity is mapped to Inventory Level.
- Check the Allow Create Variant setting in Advanced Settings if new variants are not appearing.
- Run the integration manually and check the logs for errors.
- Confirm the Lightspeed connection (shared from Primary) is still active with Test Connection.
What's happening
Send Fulfillment Requests fails to submit orders through Lightspeed. The order may be rejected or the connection may time out.
- Lightspeed credentials may be incorrect.
- Required order fields (shipping address, item details) may not be mapped.
- Register ID, User ID, or Tax ID may be invalid.
How to fix it
- Verify the Lightspeed connection credentials.
- Open the Send Fulfillment Requests mapping template and confirm all required shipping address fields are mapped.
- Check the integration logs for specific error messages.
- If the connection was working before, confirm access is still active on the Lightspeed side.
Still need help? If you're experiencing issues not covered here, contact Lightspeed or your Flxpoint account manager.
Contact Support