Lightspeed Retail

Lightspeed Retail (X-Series) is a cloud-based retail point-of-sale and inventory management platform. Its REST API exposes retail operations data — customers, products, inventory, sales, outlets, suppliers, and more — so you can sync store data into your warehouse and push records back into Lightspeed. Nexla connects to the X-Series API using a personal token and your account's domain prefix.

Power end-to-end data operations for your Lightspeed Retail API with Nexla. Our bi-directional Lightspeed Retail connector is purpose-built for Lightspeed Retail, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Lightspeed Retail or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Lightspeed Retail workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Lightspeed Retail credential, you need your account's domain prefix (subdomain) and a personal token. The X-Series API authenticates every request with a Bearer token sent in the Authorization header, and it uses your domain prefix to construct the API endpoint URL: https://{domain_prefix}.retail.lightspeed.app/api/2.0/.

To obtain your Lightspeed Retail credentials, follow these steps:

1. Sign in to your Retail POS (X-Series) account with administrator credentials.

2. Note your domain prefix (subdomain). This is the first part of your Retail POS URL — for example, if you access Retail POS at https://your-account.retail.lightspeed.app, then your domain prefix is your-account.

3. In the back office, navigate to Setup > Personal Tokens.

4. Click Add Personal Token.

5. Enter a Token name for your reference (for example, "Nexla Integration"). Optionally set an Expiry date; by default the token does not expire.

6. Click Generate Personal Token.

7. Copy the generated token immediately and store it securely — it may not be shown again after you leave the page.

A personal token grants API access equivalent to an Admin user's data access, so treat it like a password and keep it confidential. If a token is compromised, revoke it in Setup > Personal Tokens and generate a new one. Personal tokens require the retailer to be on a qualifying plan and are being phased out in favor of private apps; consult the vendor documentation if you need to migrate. For full details, see the Lightspeed Retail (X-Series) API documentation and the personal tokens support guide.

Authenticate

Credentials required

Field	Required	Secret	Description
Subdomain	Yes	No	Your Lightspeed Retail account subdomain. Endpoint: https://<subdomain>.retail.lightspeed.app/api/2.0/ Example: your-account
API Key	Yes	Yes	Lightspeed Retail API key for authentication. Found in admin dashboard under API settings.

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your account's domain prefix in the Subdomain field. This is the first part of your Retail POS URL — for example, your-account for https://your-account.retail.lightspeed.app.

4. Enter your personal token in the API Key field. This is the token you generated in Prerequisites. Nexla sends it as a Bearer token in the Authorization header on every request and it must be kept confidential.

   A personal token provides Admin-level access to your Retail POS data. If it is compromised, revoke it in Setup > Personal Tokens and generate a new one.

   For detailed information about authentication, endpoints, and API response structures, see the Lightspeed Retail (X-Series) API documentation.

5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Lightspeed Retail connector tile, then select the credential that will be used to connect to the Lightspeed Retail instance, and click Next; or, create a new Lightspeed Retail credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Lightspeed Retail endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List Users

Returns a list of all users in the Lightspeed Retail account.

[Rest API] List Customers

Returns a list of all customers in the Lightspeed Retail account.

[Rest API] List Security Events

Returns a list of security events and audit logs for the Lightspeed Retail account.

[Rest API] List Brands

Returns a list of all brands in the Lightspeed Retail account.

[Rest API] List Variant Attributes

Returns a list of all product variant attributes in the Lightspeed Retail account.

[Rest API] List Taxes

Returns a list of all tax configurations in the Lightspeed Retail account.

[Rest API] List Tags

Returns a list of all tags in the Lightspeed Retail account.

[Rest API] List Suppliers

Returns a list of all suppliers in the Lightspeed Retail account.

[Rest API] List Serial Numbers

Returns a list of all serial numbers in the Lightspeed Retail account.

[Rest API] List Sales

Returns a list of all sales transactions in the Lightspeed Retail account.

[Rest API] List Registers

Returns a list of all registers in the Lightspeed Retail account.

[Rest API] List Quotes

Returns a list of all quotes in the Lightspeed Retail account.

[Rest API] List Services

Returns a list of all services available in the Lightspeed Retail account.

[Rest API] List Promotions

Returns a list of all promotions configured in the Lightspeed Retail account.

[Rest API] List Products

Returns a list of all products in the Lightspeed Retail catalog.

[Rest API] List Product Categories

Returns a list of all product categories in the Lightspeed Retail account.

[Rest API] List Price Book Products

Returns a list of products associated with price books in the Lightspeed Retail account.

[Rest API] List Payment Types

Returns a list of all payment types configured in the Lightspeed Retail account.

[Rest API] List Outlets

Returns a list of all outlets in the Lightspeed Retail account.

[Rest API] List Inventory

Returns a list of inventory records for products in the Lightspeed Retail account.

[Rest API] List Fulfillments

Returns a list of fulfillments for sales orders.

[Rest API] List Customer Groups

Returns a list of customer groups in the retail account.

[Rest API] List Consignments

Returns a list of consignments in the retail account.

[Rest API] List Consignment Products

Returns a list of products associated with a specific consignment.

• This endpoint requires a Consignment ID — the ID of the consignment to retrieve products for.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Lightspeed Retail data sources can also be manually configured to ingest data from any valid Lightspeed Retail (X-Series) API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Lightspeed Retail data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Lightspeed Retail destination, and select the Send to Destination option from the menu. Select the Lightspeed Retail connector from the list of available destination connectors, then select the credential that will be used to connect to the Lightspeed Retail account, and click Next; or, create a new Lightspeed Retail credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Lightspeed Retail endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Create Customer

Creates a new customer record in Lightspeed Retail. Each record from your Nexset is sent as a JSON request body to create a customer.

[Rest API] Update Customer

Updates an existing customer record in Lightspeed Retail by customer ID.

• This endpoint requires a Customer ID — the unique identifier of the customer to update.

[Rest API] Delete Customer

Deletes a customer record from Lightspeed Retail by customer ID.

• This endpoint requires a Customer ID — the unique identifier of the customer to delete.

[Rest API] Create Product

Creates a new product in the Lightspeed Retail catalog. Each record from your Nexset is sent as a JSON request body to create a product.

[Rest API] Update Product

Updates an existing product in the Lightspeed Retail catalog by product ID.

• This endpoint requires a Product ID — the unique identifier of the product to update.

[Rest API] Delete Product

Deletes a product from the Lightspeed Retail catalog by product ID.

• This endpoint requires a Product ID — the unique identifier of the product to delete.

[Rest API] Create Sale

Creates a new sale transaction in Lightspeed Retail. Each record from your Nexset is sent as a JSON request body to create a sale.

Manual configuration

Lightspeed Retail destinations can also be manually configured to send data to any valid Lightspeed Retail API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Lightspeed Retail APIs expect JSON format for write operations. For update and delete operations, include the ID of the object to be modified at the end of the URL.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Lightspeed Retail endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Lightspeed Retail endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.