Skip to content
MCP server

Lightspeed Retail (R-Series) MCP by usefulapi

Read Lightspeed R-Series items, stock, sales, customers and POs; create customers and…

Install
Runs
Remotely
Version
1.37.0
Listing updated
4 days ago

About Lightspeed Retail (R-Series) MCP by usefulapi

Lightspeed Retail (R-Series) MCP by usefulapi is an MCP server. It runs as a hosted remote server, so there is nothing to install locally.

Read Lightspeed R-Series items, stock, sales, customers and POs; create customers and set stock.

Install

Run in a terminal

claude mcp add --transport http lightspeed-r-series https://lightspeed-r-series.usefulapi.io/mcp

Add to Settings → Connectors → Add custom connector

https://lightspeed-r-series.usefulapi.io/mcp
Install in CursorOpens Cursor, which asks you to confirm. Or add it by hand:

Add to ~/.cursor/mcp.json

{
  "mcpServers": {
    "lightspeed-r-series": {
      "url": "https://lightspeed-r-series.usefulapi.io/mcp"
    }
  }
}
Install in VS CodeOpens VS Code, which asks you to confirm. Or add it by hand:

Add to .vscode/mcp.json

{
  "servers": {
    "lightspeed-r-series": {
      "type": "http",
      "url": "https://lightspeed-r-series.usefulapi.io/mcp"
    }
  }
}

Add to ~/.codeium/windsurf/mcp_config.json

{
  "mcpServers": {
    "lightspeed-r-series": {
      "serverUrl": "https://lightspeed-r-series.usefulapi.io/mcp"
    }
  }
}

Add to your client's MCP settings (most use this shape)

{
  "mcpServers": {
    "lightspeed-r-series": {
      "type": "http",
      "url": "https://lightspeed-r-series.usefulapi.io/mcp"
    }
  }
}

Tools this server provides (18)

Read directly from the server.

lightspeedrseries_get_account
The connected Lightspeed Retail (R-Series) account: id, name, status, employee count/limit, default and purchasing currencies. Good first call. GET /Account/{accountID}.json.
lightspeedrseries_list_shops
List the account's shops (store locations): shopID, name, time zone, archived flag. Use shopID to filter sales, inventory and purchase orders. GET /Account/{accountID}/Shop.json.
lightspeedrseries_list_items
Search the product catalog. Each item has itemID, description, SKUs (systemSku, customSku, upc, ean, manufacturerSku), defaultCost, categoryID and its Prices (price levels). Set include_stock to add per-shop quantities (ItemShops; shopID 0 = all shops). Paginate with next_url. GET /Account/{accountID}/Item.json.
lightspeedrseries_get_item
One item by itemID with its prices, per-shop stock (ItemShops), category and other related records. GET /Account/{accountID}/Item/{itemID}.json.
lightspeedrseries_list_inventory
Stock levels per item per shop (ItemShop records): qoh (quantity on hand), sellable, backorder, reorderPoint, reorderLevel, costs and values. shopID 0 is the all-shops summary. Paginate with next_url. GET /Account/{accountID}/ItemShop.json.
lightspeedrseries_list_inventory_log
Inventory change history (InventoryLog, read-only): one record per stock change with itemID, shopID, qohChange (+ received, - removed), costChange (the item's new unit cost after the change), reason (e.g. ManualQuantityAdjustment, ItemImport, AddInventoryForCount, RemoveForTransaction; the vendor's list is not exhaustive), createTime, employeeID, automated, and the source record when there is one:
lightspeedrseries_list_categories
Item categories (hierarchical): categoryID, name, fullPathName, parentID, nodeDepth. GET /Account/{accountID}/Category.json.
lightspeedrseries_list_sales
Sales history: saleID, completed/voided flags, completeTime, totals (calcSubtotal, calcTax1/2, total, balance), customerID, employeeID, shopID, registerID. Filter by a date range on completeTime (default) or timeStamp, shop, customer, employee. Set include_lines for SaleLines (items sold). Paginate with next_url. GET /Account/{accountID}/Sale.json.
lightspeedrseries_get_sale
One sale by saleID with its line items (SaleLines with Item), payments (SalePayments with PaymentType) and customer. GET /Account/{accountID}/Sale/{saleID}.json.
lightspeedrseries_list_customers
Search customers by name, company or email: customerID, firstName, lastName, company, customerTypeID, createTime. Email search loads the Contact relation (emails, phones, addresses). Paginate with next_url. GET /Account/{accountID}/Customer.json.
lightspeedrseries_get_customer
One customer by customerID with Contact (emails, phones, addresses), customer type and notes. GET /Account/{accountID}/Customer/{customerID}.json.
lightspeedrseries_list_vendors
Suppliers: vendorID, name, accountNumber, archived. GET /Account/{accountID}/Vendor.json.
lightspeedrseries_list_purchase_orders
Purchase orders to vendors: orderID, vendorID, shopID, orderedDate, arrivalDate, receivedDate, complete, totalQuantity, shipCost. GET /Account/{accountID}/Order.json.
lightspeedrseries_get_purchase_order
One purchase order by orderID with its lines (OrderLines: itemID, quantity, numReceived, price), vendor and shop. GET /Account/{accountID}/Order/{orderID}.json.
lightspeedrseries_list_employees
Employees: employeeID, firstName, lastName, lockOut, archived, employeeRoleID, limitToShopID. Use employeeID to filter sales. GET /Account/{accountID}/Employee.json.
lightspeedrseries_create_customer
Create a new customer, optionally with a primary email and one phone number (stored in the customer's Contact). Give at least a first name, last name or company. Returns the new customer with its customerID. POST /Account/{accountID}/Customer.json.
lightspeedrseries_update_item
Change fields of an existing item: description, default cost, SKUs, category. Only the fields you pass are changed. Prices and stock are not changed here (use lightspeedrseries_update_stock for quantities). PUT /Account/{accountID}/Item/{itemID}.json.
lightspeedrseries_update_stock
CHANGES STOCK COUNTS: sets (does not add to) the quantity on hand of one item in one shop to `qoh`, by updating the item's ItemShop record. Use for correcting a few items; for many items use an inventory count in Lightspeed. Identify the shop by shop_id, or by item_shop_id from lightspeedrseries_get_item's ItemShops. Not for shopID 0 (the all-shops summary). PUT /Account/{accountID}/Item/{itemID}.

Lightspeed Retail (R-Series) MCP by usefulapi FAQ

How do I add Lightspeed Retail (R-Series) MCP by usefulapi to Claude Code?

Run this command in your terminal: claude mcp add --transport http lightspeed-r-series https://lightspeed-r-series.usefulapi.io/mcp