Lightspeed Retail (X-Series)
Move Lightspeed Retail (X-Series) orders, products and stock to the rest of your business without re-keying.
50 ways to read, 20 ways to write, each write switched on by you.
Quality checks
Built and tested with example responses.
- Ready to connect: doneEvery listed action is built in.
- Built and tested with example responses: doneEach action is built from the provider’s published API and tested against example responses, errors, rate limits and paging.
Connected, approved, proven.
The things teams do most with Lightspeed Retail (X-Series), an example flow with a person in the loop, and what Nexra keeps as proof.
Top actions
- Create brandApproval by rule
- Add product to consignmentApproval by rule
- List brandsRead
Example flow
- Lightspeed Retail (X-Series) · List brandsDone
- Lightspeed Retail (X-Series) · Create brandNeeds approval
- Nexra · Record the decision and result in the evidence chainProven
Example workflow. Routine runs go through on their own. Only a change your rules flag, such as one over a limit you set, waits for the right person, who sees the exact change and the rule before it reaches Lightspeed Retail (X-Series).
What gets logged
- Whether it ran on its own or who approved it, and under which rule
- A fingerprint of the exact request sent to Lightspeed Retail (X-Series)
- Lightspeed Retail (X-Series)'s reply: what it created or changed
- One entry in the evidence chain, linked to the one before
Try this in the sandbox
Run the whole flow with test data in your sandbox, then connect your own account when you are ready to go live.
For developers
Technical detail
Read and write Lightspeed Retail X-Series products, variants, price books, tags, brands, inventory, stock orders, customers and suppliers; read and search sales, quotes and purchase orders.
Lightspeed Commerce API docs- Source actions
- 50
- Destination actions
- 20
- Data types
- 31
What you can map
Reads are always available. Writes are off until you switch them on for a connection, and governed writes follow your policies.
Brands4
- Create brandDestinationNot retried automaticallyApproval before production
Creates a brand.
- Get brandSource
One brand by ID.
- List brandsSourceIncremental
Brands ordered by version, optionally changed after a version.
- Update brandDestinationProvider duplicate protectionApproval before production
Renames a brand or changes its description.
Consignment products2
- Add product to consignmentDestinationNot retried automaticallyApproval before production
Adds a product line with count, cost and received quantity to a consignment.
- List consignment productsSourceIncremental
Consignment products ordered by version, optionally changed after a version.
Consignments4
- Create consignmentDestinationNot retried automaticallyApproval before production
Creates a stock order from a supplier (SUPPLIER), a transfer between your outlets (OUTLET) or a stocktake (STOCKTAKE).
- Get consignmentSource
One consignment by ID.
- List consignmentsSourceIncremental
Consignments ordered by version, optionally changed after a version.
- Update consignmentDestinationProvider duplicate protectionApproval before production
Progresses a consignment (for example SENT, DISPATCHED, RECEIVED) and updates its details.
Current user1
- Get token userSource
The user the personal token acts as, with role and outlet restrictions.
Customer groups1
- List customer groupsSourceIncremental
Customer groups ordered by version, optionally changed after a version.
Customers5
- Create customerDestinationNot retried automaticallyApproval before production
Creates a customer with contact, address, group and marketing preferences.
- Get customerSource
One customer by ID.
- List customersSourceIncremental
Customers ordered by version, optionally changed after a version.
- Search customersSource
Customers by customer code or company name.
- Update customerDestinationProvider duplicate protectionApproval before production
Updates a customer; first and last name are required by Lightspeed.
Inventory adjustment reasons1
- List custom stock adjustment reasonsSourceIncremental
Custom stock adjustment reasons ordered by version, optionally changed after a version.
Inventory levels1
- List inventory levelsSource
Stock level, cost and procurement need per product and location.
Inventory1
- List inventory recordsSourceIncremental
Inventory per product and outlet with reorder settings, ordered by version.
Outlets2
- Get outletSource
One outlet by ID.
- List outletsSourceIncremental
Outlets ordered by version, optionally changed after a version.
Payment types1
- List payment typesSourceIncremental
Payment types ordered by version, optionally changed after a version.
Price book products3
- Add products to price bookDestinationNot retried automaticallyApproval before production
Adds product prices to a price book.
- List price book productsSource
Product prices in one price book, optionally for selected products.
- Update price book productsDestinationProvider duplicate protectionApproval before production
Updates the supplied product prices in a price book; other entries are unchanged.
Price books4
- Create price bookDestinationNot retried automaticallyApproval before production
Creates a price book for customer groups and outlets, optionally time-bound.
- Get price bookSource
One price book by ID.
- List price booksSourceIncremental
Price books ordered by version, optionally changed after a version.
- Update price bookDestinationProvider duplicate protectionApproval before production
Updates a price book. Lightspeed requires the name, customer groups and outlets.
Product categories1
- List product categoriesSource
Product category hierarchy.
Product price books1
- List price books for a productSource
Every price book entry that prices one product.
Product types1
- Get product typeSource
One product type by ID.
Products5
- Create productDestinationNot retried automaticallyApproval before production
Creates a product, optionally with variants and opening inventory per outlet.
- Get productSource
One product by ID.
- List productsSourceIncremental
Products ordered by version, optionally changed after a version.
- Search productsSource
Products matching a SKU, brand, supplier, tag, product type or variant family.
- Update productDestinationProvider duplicate protectionApproval before production
Updates family details (name, description, brand, category, tags) and product details (prices, active flag, inventory per outlet).
Purchase order deliveries1
- List purchase order deliveriesSourceIncremental
Purchase order deliveries ordered by version, optionally changed after a version.
Purchase order line items1
- List purchase order line itemsSourceIncremental
Purchase order line items ordered by version, optionally changed after a version.
Purchase orders2
- Get purchase orderSource
One purchase order by ID.
- List purchase ordersSourceIncremental
Purchase orders ordered by version, optionally changed after a version.
Quotes2
- Get quoteSource
One quote by ID.
- List quotesSource
Sale quotes with status, customer and totals.
Registers2
- Get registerSource
One register by ID.
- List registersSourceIncremental
Registers ordered by version, optionally changed after a version.
Retailer1
- Get retailerSource
Store name, currency, time zone, tax mode and enabled features.
Sales3
- Get saleSource
One sale by ID.
- List salesSourceIncremental
Sales ordered by version, optionally changed after a version.
- Search salesSourceIncremental
Sales by outlet, register, customer, user, state, invoice number or date range.
Serial numbers2
- Get serial numberSource
One serial number by ID.
- List serial numbersSourceIncremental
Serial numbers ordered by version, optionally changed after a version.
Stock adjustments2
- Create stock adjustmentsDestinationNot retried automaticallyApproval before production
Records one or more reasoned stock adjustments (damage, theft, stock found and so on) in a batch.
- List stock adjustmentsSourceIncremental
Stock adjustments ordered by version, optionally changed after a version.
Suppliers4
- Create supplierDestinationNot retried automaticallyApproval before production
Creates a supplier with contact details.
- Get supplierSource
One supplier by ID.
- List suppliersSourceIncremental
Suppliers ordered by version, optionally changed after a version.
- Update supplierDestinationProvider duplicate protectionApproval before production
Updates a supplier's name, description, markup and contact details.
Tags4
- Create tagDestinationNot retried automaticallyApproval before production
Creates a product tag.
- Get tagSource
One tag by ID.
- List product tagsSourceIncremental
Product tags ordered by version, optionally changed after a version.
- Rename tagDestinationProvider duplicate protectionApproval before production
Renames a tag; Lightspeed applies the change to tagged products in a background job.
Taxes2
- Get taxSource
One tax by ID.
- List taxesSourceIncremental
Taxes ordered by version, optionally changed after a version.
Users2
- Get userSource
One user by ID.
- List usersSourceIncremental
Users ordered by version, optionally changed after a version.
Variant attributes4
- Create variant attributeDestinationNot retried automaticallyApproval before production
Creates a variant attribute such as Size or Colour.
- Get variant attributeSource
One variant attribute by ID.
- List variant attributesSource
Attributes such as size and colour used to define variant families.
- Rename variant attributeDestinationProvider duplicate protectionApproval before production
Renames a variant attribute.
Access and limits
- 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. Flows run on demand, on a schedule, or when a scheduled check finds new or changed records.
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.
- 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.
- Search never filters by email, phone or personal names, so no personal data is placed in URLs. Customer search supports customer code and company name only.
- Price book products are added with POST and merged with PATCH; the replace-all PUT is not used. Quote list paging passes the last quote ID as after, which the reference does not define.
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.