Read Lightspeed X-Series products, stock, sales, customers, stock orders; one-call sales reports. Hosted by usefulapi — connect from Claude, ChatGPT, Cursor, or any MCP client.
Team and Enterprise: an Owner adds the connector for the organization first.
Run this command, then run /mcp in Claude Code to log in:
Add to Cursor or add this to ~/.cursor/mcp.json:
{
"mcpServers": {
"lightspeed-x-series": {
"url": "https://lightspeed-x-series.usefulapi.io/mcp"
}
}
}Add to VS Code or add this to .vscode/mcp.json:
{
"servers": {
"lightspeed-x-series": {
"type": "http",
"url": "https://lightspeed-x-series.usefulapi.io/mcp"
}
}
}No Add custom MCP server option? It depends on your account or workspace settings: see OpenAI's guide.
Run these commands. The second one opens the login page:
Other MCP clients (Windsurf, Cline, Zed and more): add the URL as a remote MCP server (Streamable HTTP). The client then opens the login page in your browser. Do not add an Authorization header: see Before you connect.
You sign in with your Lightspeed Retail (X-Series) account and approve the access (OAuth). You do not need an API key.
This server reads your products, stock levels, sales, customers, suppliers, stock orders, outlets, registers and staff, and can create and update customers, set product prices and set stock levels when you ask it to. You can remove its access any time in your Lightspeed Retail back office.
Add only the URL. Do not add an Authorization header or an API key to the client config. The server signs you in with OAuth: you sign in with your Lightspeed Retail (X-Series) account. If the config has such a header, remove it: some clients then send that header instead of the login token, and every call fails with 401.
Turn on the Lightspeed Retail (X-Series) connector, then ask in plain words. The AI picks the tools.
| Tool | Type | What it does |
|---|---|---|
lightspeedxseries_get_retailer | read | Get retailer The connected store: id, name, domain prefix, store URL, country, currency, time zone, tax-exclusive setting, loyalty and gift-card settings. Good first call (use the time zone to turn a local day into UTC for sales searches). GET /retailer. |
lightspeedxseries_list_outlets | read | List outlets List the store's outlets (locations): id, name, address, currency, time zone, default tax. Use the outlet id to filter sales, stock and stock orders. Paginate with next_after. GET /outlets. |
lightspeedxseries_get_outlet | read | Get outlet One outlet by id. GET /outlets/{outlet_id}. |
lightspeedxseries_list_registers | read | List registers List registers (tills): id, name, outlet_id, is_open, open/close times and invoice numbering. Paginate with next_after. GET /registers. |
lightspeedxseries_get_register_payments_summary | read | Get register payments summary Payment totals by payment type for one register since it was opened (the end-of-day / cash-up view). GET /registers/{register_id}/payments_summary. |
lightspeedxseries_list_taxes | read | List taxes List tax groups and their rates (id, name, is_default, rates). The vendor returns the whole list in one reply (no cursor). GET /taxes. |
lightspeedxseries_list_users | read | List users List the store's users (staff): id, username, display name, email, account type (cashier, manager, admin), enabled flag, restricted outlets. Paginate with next_after. GET /users. |
lightspeedxseries_get_user_sale_totals | read | Get user sale totals Sales totals for one staff user, as the vendor computes them (no date filter; use sales_summary for a period). GET /users/{user_id}/sale_totals. |
lightspeedxseries_list_products | read | List products List products (variants) in the catalog: id, family_id, sku, variant_name, prices (price_excluding_tax / price_including_tax), active flags, codes, suppliers, version. The product NAME lives on the product family: add includes=["families"] to get it. Paginate with next_after (stop when data is empty). With sku set, only that SKU is looked up and the other filters are ignored. For text/brand/supplier filters use search_products; for stock use get_inventory_levels. GET /products. |
lightspeedxseries_get_product | read | Get product One product (variant) by id, with its prices, codes, suppliers and outlet taxes. GET /products/{product_id}. |
lightspeedxseries_search_products | read | Search products Filter products by SKU, brand, supplier, tag, product type or variant parent. Uses offset paging: pass next_offset to continue (null = last page). GET /search?type=products. |
lightspeedxseries_get_inventory_levels | read | Get inventory levels Stock on hand per product per outlet: product_id, location_id (= outlet id), current_inventory_level, reorder threshold/amount, quantity_to_procure, average cost, total cost, supplier. Filter by outlet_ids, product_ids (or root_product_ids for variant families), supplier_ids; to_be_procured_only keeps products with a positive quantity_to_procure (the vendor's re-order suggestion, which accounts for open orders); for a plain below-reorder-point list, compare current_inventory_level with reorder_threshold yourself. Offset paging: pass next_offset to continue (null = last page). Read-only even though the vendor takes the filter as a POST body. POST /inventory_levels. |
lightspeedxseries_list_brands | read | List brands List product brands (id, name). Paginate with next_after. GET /brands. |
lightspeedxseries_list_tags | read | List tags List product tags (id, name). Paginate with next_after. GET /tags. |
lightspeedxseries_list_suppliers | read | List suppliers List suppliers: id, name, default markup and contact details. Paginate with next_after. GET /suppliers. |
lightspeedxseries_list_consignments | read | List stock orders (consignments) List consignments: supplier stock orders (type SUPPLIER), transfers between outlets (OUTLET), stocktakes (STOCKTAKE) and returns (RETURN), with status (OPEN, SENT, DISPATCHED, RECEIVED, STOCKTAKE_*, CLOSED, CANCELLED), outlet, supplier, due and received dates, totals. Paginate with next_after. GET /consignments. |
lightspeedxseries_get_consignment | read | Get consignment One consignment (stock order, transfer, stocktake or return) by id. GET /consignments/{consignment_id}. |
lightspeedxseries_list_consignment_products | read | List consignment products The product lines of one consignment: product_id, SKU, ordered count, received quantity, cost. Paginate with next_after (stop when data is empty). GET /consignments/{consignment_id}/products. |
lightspeedxseries_list_sales | read | List sales (change feed) Sales in version order, oldest changes first: the way to sync everything that changed. It has NO date filter: for a period use search_sales or sales_summary. Each sale: id, date, invoice_number, state, customer_id, source (outlet, register, user), payments, line_items, totals. Paginate with next_after (stop when data is empty). GET /sales. |
lightspeedxseries_get_sale | read | Get sale One sale by id with its line items, payments, taxes and totals. GET /sales/{sale_id}. |
lightspeedxseries_search_sales | read | Search sales Find sales by date range (UTC), state, outlet, register, user, customer, payment type, product or invoice number. Uses offset paging: pass next_offset to continue (null = last page). Replies can be large: for totals over a period use sales_summary instead of paging through this. GET /search?type=sales. |
lightspeedxseries_sales_summary | read | Sales summary (totals for a period) Totals for a period computed here from up to max_pages x page_size sales, so a report needs ONE tool call instead of dozens: sale count and net / tax / gross (tax-inclusive) totals, plus breakdowns by state, UTC day, outlet and payment type name, and the top products by quantity. By default only closed sales are counted (states containing 'closed'); set counted_states to change that. Dates are UTC (convert local days with the retailer's time zone). If the reply says truncated, call again with offset = next_offset and add the figures up. Uses GET /search?type=sales. |
lightspeedxseries_list_customers | read | List customers List customers in version order: id, customer_code, name, email, phone, balance, loyalty_balance, year_to_date, customer group. To find one by name or email use search_customers. Paginate with next_after (stop when data is empty). GET /customers. |
lightspeedxseries_search_customers | read | Search customers Find customers by email, first name, last name, company name, phone, mobile or customer code. Uses offset paging: pass next_offset to continue (null = last page). GET /search?type=customers. |
lightspeedxseries_get_customer | read | Get customer One customer by id: contact details, addresses, customer group, balance, loyalty balance, year-to-date spend. GET /customers/{customer_id}. |
lightspeedxseries_list_customer_groups | read | List customer groups List customer groups (id, name). Use the id as customer_group_id when creating or updating a customer. Paginate with next_after. GET /customer_groups. |
lightspeedxseries_create_customer | write | Create customer WRITE: create a new customer. Give at least a first name, last name or company name. Check search_customers first so you do not create a duplicate. POST /customers. |
lightspeedxseries_update_customer | write | Update customer WRITE: change fields of an existing customer. Only the fields you pass change: the tool first reads the customer and sends the vendor its full record with your changes applied (the vendor's update is a full PUT). Cannot delete a customer or change balances. Lightspeed offers no partial update for customers, so a change made by someone else in the moments between the tool's read and its write can be overwritten. PUT /customers/{customer_id}. |
lightspeedxseries_update_product_prices | write | Update product prices WRITE: set the selling price of one product (variant). Pass price_excluding_tax or price_including_tax as a decimal string such as "24.99" (set one; the store's tax setting decides which the till uses). Nothing else on the product changes. Read the product first and confirm the new price with the user. PATCH /products/{product_id}. |
lightspeedxseries_set_product_stock | write | Set product stock and reorder levels WRITE: set the stock on hand (current_amount) and/or the reorder point and reorder amount of ONE product at ONE outlet. current_amount is the NEW TOTAL on hand, not a change: it overwrites the count, so sales made since you last read it are lost from the count. Read get_inventory_levels first and confirm the number with the user. Other outlets and all other product fields stay as they are. PATCH /products/{product_id} (outlet_inventories). |
lightspeedxseries_usage_status | Usage status (free-tier meter) Report the caller's current free-tier usage this month: calls used, monthly limit, remaining, and whether the cap is reached. Read-only; does not count against the meter. | |
lightspeedxseries_request_feature | Request a missing feature Tell usefulapi that the user needs something the Lightspeed Retail (X-Series) tools cannot do yet (a missing tool, field or filter). Call it only when the user asks for something none of the tools can do, and tell the user that you send the request. Do not call it for errors or for normal requests. Do not include personal data, credentials or customer records. Stored with the product name and the client type (for example Claude or Cursor), without the user's account. At most 5 requests per day. Does not count against the meter. | |
lightspeedxseries_upgrade | Upgrade to Pro (unlimited) Subscribe to the Pro plan for UNLIMITED Lightspeed Retail (X-Series) tool calls (the free tier caps monthly usage). Choose monthly ($9/month) or yearly ($90/year — 2 months free) billing. Returns a short link to open in your browser (it opens Stripe Checkout); after payment your account upgrades automatically. Does not count against the meter. | |
lightspeedxseries_cancel_subscription | Cancel the Pro subscription Cancel the caller's Lightspeed Retail (X-Series) Pro subscription at the end of the paid period (no refund for the current period; unlimited calls continue until then, then the free tier applies). Requires confirm: true. Run lightspeedxseries_upgrade later to undo the cancel before the period ends. Does not count against the meter. |
| Plan | Price | Limit |
|---|---|---|
| Free | $0 | 50 tool calls / month |
| Proper store account | $9/mo · $90/yr | Unlimited |
Pro covers this Lightspeed Retail (X-Series) server only. Subscribe with lightspeedxseries_upgrade (it returns a Stripe Checkout link). Cancel any time with lightspeedxseries_cancel_subscription: Pro continues to the end of the paid period, with no refund for the current period, and running lightspeedxseries_upgrade before then undoes the cancel. Or write to [email protected].
No. usefulapi is an independent service. It is not affiliated with or endorsed by Lightspeed Retail (X-Series). The server calls the Lightspeed Retail (X-Series) API with your own Lightspeed Retail (X-Series) access, so it sees only the data that your account can see.
Yes. In Claude, add this server's URL as a custom connector. In ChatGPT, add it as a custom MCP server in Plugins. Then log in once. Cursor, VS Code, Claude Code and Codex work too. See the setup steps.
A Lightspeed Retail (X-Series) account. You sign in to Lightspeed Retail (X-Series) and approve the access. You do not need an API key.
No. Add only the URL. Do not add an Authorization header or an API key to the client config. The server signs you in with OAuth: you sign in with your Lightspeed Retail (X-Series) account. If the config has such a header, remove it: some clients then send that header instead of the login token, and every call fails with 401.
The login stores them encrypted in the authorization grant of your connection. The server uses them to call the Lightspeed Retail (X-Series) API for you and to derive a private account id for usage metering. usefulapi does not show them on any page or in any reply. You can revoke the access in Lightspeed Retail (X-Series) at any time.
Yes, if you approve it. 4 of the 30 Lightspeed Retail (X-Series) tools can create or change data. The other 26 are marked read-only. Most MCP clients ask you to approve a tool call before it runs.
The Free plan gives 50 tool calls / month. Pro costs $9/mo or $90/yr, with unlimited tool calls, for this Lightspeed Retail (X-Series) server only. Run lightspeedxseries_usage_status to see how many calls you used.
Ask the AI to run lightspeedxseries_upgrade: it returns a Stripe Checkout link. To cancel, run lightspeedxseries_cancel_subscription. Pro continues to the end of the paid period.
Tell the AI what you wanted to do. It can send the request with lightspeedxseries_request_feature. We store the text with the server name, the type of AI client and the tool you tried, not with your account, and read every request when we plan new tools. You can send up to 5 requests per day.
Any client that supports remote MCP servers (Streamable HTTP) with OAuth login: Claude (web and desktop), Claude Code, ChatGPT, Codex, Cursor, VS Code, Windsurf and others.
This is a Model Context Protocol endpoint — meant to be connected from an AI client, not opened in a browser. An invalid_token response at the URL is the auth gate working as designed; clients authenticate automatically.