Lightspeed Retail (X-Series)
Read and write Lightspeed Retail X-Series products and variants, outlet inventory, stock adjustments, stock orders and transfers, customers and suppliers, and read sales and purchase orders.
Synchronise point-of-sale catalogue, stock by outlet, supplier orders and customers with e-commerce, ERP and accounting systems.
Source actions
22
Destination actions
10
Data types
15
Validation status
Implemented · fixture tested.
Implementation is checked against provider-shaped fixtures for every action, authentication failures, rate limits, pagination and duplicate safety. Provider sandbox and authorised account validation are recorded separately when credential-backed runs are completed.
What you can map
brands
- List brandsSourceIncremental
Brands ordered by version, optionally changed after a version.
brands.list
consignment products
- Add product to consignmentDestinationNot retried automaticallyApproval before production
Adds a product line with count, cost and received quantity to a consignment.
consignment_products.create - List consignment productsSourceIncremental
Consignment products ordered by version, optionally changed after a version.
consignment_products.list
consignments
- Create consignmentDestinationNot retried automaticallyApproval before production
Creates a stock order from a supplier (SUPPLIER), a transfer between your outlets (OUTLET) or a stocktake (STOCKTAKE).
consignments.create - Get consignmentSource
One consignment by ID.
consignments.get - List consignmentsSourceIncremental
Consignments ordered by version, optionally changed after a version.
consignments.list - Update consignmentDestinationProvider duplicate protectionApproval before production
Progresses a consignment (for example SENT, DISPATCHED, RECEIVED) and updates its details.
consignments.update
customer groups
- List customer groupsSourceIncremental
Customer groups ordered by version, optionally changed after a version.
customer_groups.list
customers
- Create customerDestinationNot retried automaticallyApproval before production
Creates a customer with contact, address, group and marketing preferences.
customers.create - Get customerSource
One customer by ID.
customers.get - List customersSourceIncremental
Customers ordered by version, optionally changed after a version.
customers.list - Update customerDestinationProvider duplicate protectionApproval before production
Updates a customer; first and last name are required by Lightspeed.
customers.update
inventory levels
- List inventory levelsSource
Stock level, cost and procurement need per product and location.
inventory_levels.list
inventory
- List inventory recordsSourceIncremental
Inventory per product and outlet with reorder settings, ordered by version.
inventory.list
outlets
- Get outletSource
One outlet by ID.
outlets.get - List outletsSourceIncremental
Outlets ordered by version, optionally changed after a version.
outlets.list
product categories
- List product categoriesSource
Product category hierarchy.
product_categories.list
products
- Create productDestinationNot retried automaticallyApproval before production
Creates a product, optionally with variants and opening inventory per outlet.
products.create - Get productSource
One product by ID.
products.get - List productsSourceIncremental
Products ordered by version, optionally changed after a version.
products.list - Update productDestinationProvider duplicate protectionApproval before production
Updates family details (name, description, brand, category, tags) and product details (prices, active flag, inventory per outlet).
products.update
purchase orders
- Get purchase orderSource
One purchase order by ID.
purchase_orders.get - List purchase ordersSourceIncremental
Purchase orders ordered by version, optionally changed after a version.
purchase_orders.list
sales
- Get saleSource
One sale by ID.
sales.get - List salesSourceIncremental
Sales ordered by version, optionally changed after a version.
sales.list
stock adjustments
- Create stock adjustmentsDestinationNot retried automaticallyApproval before production
Records one or more reasoned stock adjustments (damage, theft, stock found and so on) in a batch.
stock_adjustments.create - List stock adjustmentsSourceIncremental
Stock adjustments ordered by version, optionally changed after a version.
stock_adjustments.list
suppliers
- Create supplierDestinationNot retried automaticallyApproval before production
Creates a supplier with contact details.
suppliers.create - Get supplierSource
One supplier by ID.
suppliers.get - List suppliersSourceIncremental
Suppliers ordered by version, optionally changed after a version.
suppliers.list - Update supplierDestinationProvider duplicate protectionApproval before production
Updates a supplier's name, description, markup and contact details.
suppliers.update
taxes
- List taxesSourceIncremental
Taxes ordered by version, optionally changed after a version.
taxes.list
Authentication
Personal token
Plans and access
Personal tokens are available to retailers on the Plus plan; add-ons use OAuth. The personal token acts as the admin user who created it and follows that user's permissions.
Test environment
Use a Lightspeed Retail X-Series trial store.
Rate limits
300 x number of registers + 50 requests per 5-minute window per retailer and application; HTTP 429 with a Retry-After date.
Pagination
Version cursor (after) with page_size; the next page starts after the highest version returned, until an empty page.
Provider events
Webhooks for sale, product, customer and inventory updates. Nexra event triggers are not yet available; flows run on demand or on a schedule.
Before you build a flow
- Pinned to API version 2026-07, which Lightspeed supports for at least 12 months; requests to retired versions fall back to the oldest supported version.
- Variants are product records that share a family (variantParentId); variant families are created with the variants array on product create.
- Consignment create and update send flat payloads as shown in Lightspeed's Creating Stock Orders guide; the OpenAPI reference wraps the same fields in data, which Nexra has not verified against a live store.
- Stock orders (SUPPLIER), outlet transfers (OUTLET) and stocktakes can be created and progressed; CANCELLED and RETURN consignments are not automated.
- Purchase orders and sales are read only; creating POS sales, payments, returns, store credit and gift cards is not automated.
- Product update returns no body in the reference; Nexra returns the product ID it updated.
- Customer updates require first and last name as documented.
- Personal tokens require the Plus plan. Deletes are not automated.
Developer reference
- Create the Lightspeed Commerce credentials described above with the narrowest permissions your flows need.
- In Nexra, open Connect, then Connections, then New connection, choose Lightspeed Retail (X-Series), enter its settings and credentials, and tick only the write actions you need. Connection guide
- Test the connection, then use its actions as flow sources and destinations. Flow guide
Machine-readable detail: GET /api/public/connect/connectors/lightspeed-retail and the Connections API.