Lightspeed Retail (X-Series)

Lightspeed Retail (X-Series)

This connector uses the Lightspeed Retail (X-Series) API (formerly Vend), date version 2026-10, of one store: https://<domain_prefix>.retail.lightspeed.app/api/2026-10. It reads outlets, registers, payment types, taxes, staff and shifts; the catalog (products and product families, categories, brands, tags, suppliers, price books, promotions); stock levels, stock adjustments, consignments and purchase orders; sales; customers, customer groups, store credit and gift cards. It can create and update products, customers, suppliers, consignments and stock adjustments and record sales. It does not cover Lightspeed Retail R-Series or Lightspeed Restaurant, which have other APIs.

Setup (2 minutes)

1. Personal tokens need the Plus plan or above. As an admin open the Retail POS back office, Setup, Personal tokens, click Add personal token, give it a name (and, if you like, an expiry date), generate it and copy the token.
2. Paste it into LIGHTSPEED_PERSONAL_TOKEN. It is sent as Authorization: Bearer <token> and acts as the user who created it.
3. Set LIGHTSPEED_DOMAIN_PREFIX to the first part of your store address: for https://mystore.retail.lightspeed.app it is mystore.
4. Run lightspeed_retail_get_retailer to check the setup.

Workflow

• Store setup: lightspeed_retail_get_retailer, lightspeed_retail_get_current_user, lightspeed_retail_list_outlets, lightspeed_retail_get_outlet, lightspeed_retail_list_registers, lightspeed_retail_get_register, lightspeed_retail_get_register_payments_summary (till totals of the open shift), lightspeed_retail_list_payment_types, lightspeed_retail_list_taxes, lightspeed_retail_get_tax, lightspeed_retail_list_users, lightspeed_retail_get_user, lightspeed_retail_list_shifts.
• Sales: for a period, a register, a customer or an invoice number use lightspeed_retail_search with type: sales and date_from/date_to (the plain list ignores dates). lightspeed_retail_list_sales walks all sales by version (for syncing), lightspeed_retail_get_sale reads one. lightspeed_retail_create_sale records a sale, lightspeed_retail_update_sale changes or completes a parked one, lightspeed_retail_return_sale starts a return.
• Catalog: lightspeed_retail_list_products (or sku for one product), lightspeed_retail_get_product, lightspeed_retail_get_product_family, lightspeed_retail_get_product_family_of_product. Since 2026-10 a product family holds the shared data (name, brand, category, tags) and each product the per-variant data (codes, prices, suppliers): create with lightspeed_retail_create_product_family, add variants with lightspeed_retail_add_products_to_family, change shared data with lightspeed_retail_update_product_family and per-product data with lightspeed_retail_update_product; lightspeed_retail_delete_product removes one product. Reference data: lightspeed_retail_list_product_categories, lightspeed_retail_list_product_types, lightspeed_retail_list_brands, lightspeed_retail_list_tags, lightspeed_retail_list_suppliers, lightspeed_retail_get_supplier, lightspeed_retail_create_supplier, lightspeed_retail_list_price_books, lightspeed_retail_list_promotions, lightspeed_retail_get_promotion.
• Stock: lightspeed_retail_list_inventory_levels (per outlet, filter and sort; to_be_procured_only for reorder lists), lightspeed_retail_get_product_inventory_levels, lightspeed_retail_list_inventory_records, lightspeed_retail_list_stock_adjustments, lightspeed_retail_create_stock_adjustments. Orders, transfers and stocktakes: lightspeed_retail_list_consignments, lightspeed_retail_get_consignment, lightspeed_retail_list_consignment_products, lightspeed_retail_create_consignment, lightspeed_retail_list_purchase_orders, lightspeed_retail_get_purchase_order.
• Customers: find one with lightspeed_retail_search (type: customers, email or names), then lightspeed_retail_get_customer; lightspeed_retail_list_customers, lightspeed_retail_create_customer, lightspeed_retail_update_customer, lightspeed_retail_delete_customer, lightspeed_retail_list_customer_groups, lightspeed_retail_get_customer_store_credit. Gift cards: lightspeed_retail_list_gift_cards, lightspeed_retail_get_gift_card.

Switched off at install: lightspeed_retail_return_sale, lightspeed_retail_delete_product and lightspeed_retail_delete_customer; they cannot be undone, so an admin switches them on when the team needs them.

Before writing: sales, returns and stock adjustments change stock and the reports at once; show the user the lines and totals and wait for a yes. lightspeed_retail_update_sale replaces the whole sale.

Reading the answers: answers wrap records in data. Ids are UUIDs. Money is a decimal number in the store currency. A sale has totals (price excluding tax, tax, price_incl_tax); on each line pricing.price is the unit price excluding tax, pricing.total the line total after discount, pricing.cost_total the cost, and tax.amount and tax.total the unit and line tax. Tax rates are fractions (0.2 = 20%). Times are UTC (ISO 8601); date_from/date_to take UTC, time_from/time_to local time with timezone. A sale state is closed, parked, pending (on account or layby) or voided.

Paging: most lists page by version: the answer has version: {min, max}; pass max as after for the next page and stop when data is empty. lightspeed_retail_search and lightspeed_retail_list_inventory_levels page with offset; gift cards with before.

Limits and errors: about 300 requests per 5 minutes per register plus 50 (429 with Retry-After). 401 means a wrong or expired token or a wrong domain prefix, 403 a user without the right (personal tokens act as their user), 404 a wrong id, 422 a validation error with the field named.