Servers Playground How we check Add a server Log in

Lightspeed Retail (X-Series) MCP by usefulapi

Working · 7.9 s

io.usefulapi/lightspeed-x-seriesv1.4.3 Domain verified

Read Lightspeed X-Series products, stock, sales, customers, stock orders; one-call sales reports.

Commerce

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://lightspeed-x-series.usefulapi.io/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

lightspeedxseries_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.

notestring

emailstring

phonestring

mobilestring

last_namestring

Last name.

first_namestring

First name.

company_namestring

do_not_emailboolean

customer_codestring

Unique customer code (generated when omitted on create).

date_of_birthstring

physical_citystring

enable_loyaltyboolean

physical_statestring

physical_suburbstring

customer_group_idstring

Customer group id (see list_customer_groups).

physical_postcodestring

physical_address_1string

physical_address_2string

physical_country_idstring

Country code such as US, CA, AU.

enable_promotional_smsboolean

This tool isn't marked read-only, so it may change something on the server or in an account you connected.

I understand, run it anyway

Lightspeed Retail (X-Series) MCP by usefulapi MCP server | mcptry

Lightspeed Retail (X-Series) MCP by usefulapi

Working · 7.9 s

io.usefulapi/lightspeed-x-seriesv1.4.3 Domain verified

Read Lightspeed X-Series products, stock, sales, customers, stock orders; one-call sales reports.

Commerce

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://lightspeed-x-series.usefulapi.io/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

lightspeedxseries_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.

notestring

emailstring

phonestring

mobilestring

last_namestring

Last name.

first_namestring

First name.

company_namestring

do_not_emailboolean

customer_codestring

Unique customer code (generated when omitted on create).

date_of_birthstring

physical_citystring

enable_loyaltyboolean

physical_statestring

physical_suburbstring

customer_group_idstring

Customer group id (see list_customer_groups).

physical_postcodestring

physical_address_1string

physical_address_2string

physical_country_idstring

Country code such as US, CA, AU.

enable_promotional_smsboolean

This tool isn't marked read-only, so it may change something on the server or in an account you connected.

I understand, run it anyway

Tools (30)

lightspeedxseries_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.

Argument	Type	Description
note	string
email	string
phone	string
mobile	string
last_name	string	Last name.
first_name	string	First name.
company_name	string
do_not_email	boolean
customer_code	string	Unique customer code (generated when omitted on create).
date_of_birth	string
physical_city	string
enable_loyalty	boolean
physical_state	string
physical_suburb	string
customer_group_id	string	Customer group id (see list_customer_groups).
physical_postcode	string
physical_address_1	string
physical_address_2	string
physical_country_id	string	Country code such as US, CA, AU.
enable_promotional_sms	boolean

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "note": {
      "type": "string",
      "maxLength": 2000
    },
    "email": {
      "type": "string",
      "format": "email",
      "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
      "maxLength": 255
    },
    "phone": {
      "type": "string",
      "maxLength": 60
    },
    "mobile": {
      "type": "string",
      "maxLength": 60
    },
    "last_name": {
      "type": "string",
      "maxLength": 255,
      "description": "Last name."
    },
    "first_name": {
      "type": "string",
      "maxLength": 255,
      "description": "First name."
    },
    "company_name": {
      "type": "string",
      "maxLength": 255
    },
    "do_not_email": {
      "type": "boolean"
    },
    "customer_code": {
      "type": "string",
      "maxLength": 100,
      "description": "Unique customer code (generated when omitted on create)."
    },
    "date_of_birth": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}"
    },
    "physical_city": {
      "type": "string",
      "maxLength": 255
    },
    "enable_loyalty": {
      "type": "boolean"
    },
    "physical_state": {
      "type": "string",
      "maxLength": 255
    },
    "physical_suburb": {
      "type": "string",
      "maxLength": 255
    },
    "customer_group_id": {
      "type": "string",
      "maxLength": 64,
      "description": "Customer group id (see list_customer_groups)."
    },
    "physical_postcode": {
      "type": "string",
      "maxLength": 30
    },
    "physical_address_1": {
      "type": "string",
      "maxLength": 255
    },
    "physical_address_2": {
      "type": "string",
      "maxLength": 255
    },
    "physical_country_id": {
      "type": "string",
      "maxLength": 10,
      "description": "Country code such as US, CA, AU."
    },
    "enable_promotional_sms": {
      "type": "boolean"
    }
  }
}

lightspeedxseries_get_consignment

One consignment (stock order, transfer, stocktake or return) by id. GET /consignments/{consignment_id}.

read-only

Argument	Type	Description
consignment_id*	string	Consignment id (from list_consignments).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "consignment_id"
  ],
  "properties": {
    "consignment_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Consignment id (from list_consignments)."
    }
  }
}

lightspeedxseries_get_customer

One customer by id: contact details, addresses, customer group, balance, loyalty balance, year-to-date spend. GET /customers/{customer_id}.

read-only

Argument	Type	Description
customer_id*	string	Customer id (from search_customers or list_customers).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id"
  ],
  "properties": {
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Customer id (from search_customers or list_customers)."
    }
  }
}

lightspeedxseries_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.

read-only

Argument	Type	Description
size	integer	Records per page (default 100, max 500 here).
offset	integer	Offset for the next page: pass next_offset from the previous call (default 0).
sort_type	string
outlet_ids	array	Only these outlets (the vendor calls them location_ids).
product_ids	array	Only these products. Not together with root_product_ids.
supplier_ids	array
group_variants	boolean

lightspeedxseries_get_outlet

One outlet by id. GET /outlets/{outlet_id}.

read-only

Argument	Type	Description
outlet_id*	string	Outlet id (from list_outlets).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "outlet_id"
  ],
  "properties": {
    "outlet_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Outlet id (from list_outlets)."
    }
  }
}

lightspeedxseries_get_product

One product (variant) by id, with its prices, codes, suppliers and outlet taxes. GET /products/{product_id}.

read-only

Argument	Type	Description
includes	array	Related records to include. 'families' is required together with brands, categories, suppliers, tags, variant_attributes or customizations.
product_id*	string	Product id (from list_products).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "product_id"
  ],
  "properties": {
    "includes": {
      "type": "array",
      "items": {
        "enum": [
          "families",
          "brands",
          "categories",
          "suppliers",
          "tags",
          "variant_attributes",
          "customizations",
          "composite_components"
        ],
        "type": "string"
      },
      "maxItems": 8,
      "description": "Related records to include. 'families' is required together with brands, categories, suppliers, tags, variant_attributes or customizations."
    },
    "product_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Product id (from list_products)."
    }
  }
}

lightspeedxseries_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.

read-only

Argument	Type	Description
register_id*	string	Register id (from list_registers).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "register_id"
  ],
  "properties": {
    "register_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Register id (from list_registers)."
    }
  }
}

lightspeedxseries_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.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

lightspeedxseries_get_sale

One sale by id with its line items, payments, taxes and totals. GET /sales/{sale_id}.

read-only

Argument	Type	Description
sale_id*	string	Sale id (from list_sales or search_sales).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "sale_id"
  ],
  "properties": {
    "sale_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Sale id (from list_sales or search_sales)."
    }
  }
}

lightspeedxseries_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.

read-only

Argument	Type	Description
user_id*	string	User id (from list_users).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "user_id"
  ],
  "properties": {
    "user_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "User id (from list_users)."
    }
  }
}

lightspeedxseries_list_brands

List product brands (id, name). Paginate with next_after. GET /brands.

read-only

Argument	Type	Description
after	integer	Cursor: only records with a version number greater than this. Omit for the first page; then pass next_after from the previous call. Stop when data is empty.
before	integer	Only records with a version number up to this (rarely needed).
deleted	boolean	true = include deleted records (default: active only).
page_size	integer	Records per page (the vendor default applies when omitted; 50-100 keeps replies short).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "after": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Cursor: only records with a version number greater than this. Omit for the first page; then pass next_after from the previous call. Stop when data is empty."
    },
    "before": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Only records with a version number up to this (rarely needed)."
    },
    "deleted": {
      "type": "boolean",
      "description": "true = include deleted records (default: active only)."
    },
    "page_size": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Records per page (the vendor default applies when omitted; 50-100 keeps replies short)."
    }
  }
}

lightspeedxseries_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.

read-only

Argument	Type	Description
after	integer	Cursor: only records with a version number greater than this. Omit for the first page; then pass next_after from the previous call. Stop when data is empty.
before	integer	Only records with a version number up to this (rarely needed).
page_size	integer	Records per page (the vendor default applies when omitted; 50-100 keeps replies short).
consignment_id*	string	Consignment id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "consignment_id"
  ],
  "properties": {
    "after": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Cursor: only records with a version number greater than this. Omit for the first page; then pass next_after from the previous call. Stop when data is empty."
    },
    "before": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Only records with a version number up to this (rarely needed)."
    },
    "page_size": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Records per page (the vendor default applies when omitted; 50-100 keeps replies short)."
    },
    "consignment_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Consignment id."
    }
  }
}

lightspeedxseries_list_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.

read-only

Argument	Type	Description
type	string	SUPPLIER = purchase / stock orders.
after	integer	Cursor: only records with a version number greater than this. Omit for the first page; then pass next_after from the previous call. Stop when data is empty.
before	integer	Only records with a version number up to this (rarely needed).
status	string
outlet_id	string	Only consignments of this outlet.
page_size	integer	Records per page (the vendor default applies when omitted; 50-100 keeps replies short).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "type": {
      "enum": [
        "SUPPLIER",
        "OUTLET",
        "STOCKTAKE",
        "RETURN"
      ],
      "type": "string",
      "description": "SUPPLIER = purchase / stock orders."
    },
    "after": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Cursor: only records with a version number greater than this. Omit for the first page; then pass next_after from the previous call. Stop when data is empty."
    },
    "before": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Only records with a version number up to this (rarely needed)."
    },
    "status": {
      "enum": [
        "OPEN",
        "SENT",
        "DISPATCHED",
        "RECEIVED",
        "STOCKTAKE_IN_PROGRESS",
        "STOCKTAKE_SCHEDULED",
        "STOCKTAKE_IN_PROGRESS_PROCESSED",
        "STOCKTAKE_COMPLETE",
        "CLOSED",
        "CANCELLED"
      ],
      "type": "string"
    },
    "outlet_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Only consignments of this outlet."
    },
    "page_size": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Records per page (the vendor default applies when omitted; 50-100 keeps replies short)."
    }
  }
}

lightspeedxseries_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.

read-only

Argument	Type	Description
after	integer	Cursor: only records with a version number greater than this. Omit for the first page; then pass next_after from the previous call. Stop when data is empty.
before	integer	Only records with a version number up to this (rarely needed).
deleted	boolean	true = include deleted records (default: active only).
page_size	integer	Records per page (the vendor default applies when omitted; 50-100 keeps replies short).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "after": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Cursor: only records with a version number greater than this. Omit for the first page; then pass next_after from the previous call. Stop when data is empty."
    },
    "before": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Only records with a version number up to this (rarely needed)."
    },
    "deleted": {
      "type": "boolean",
      "description": "true = include deleted records (default: active only)."
    },
    "page_size": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Records per page (the vendor default applies when omitted; 50-100 keeps replies short)."
    }
  }
}

lightspeedxseries_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.

read-only

Argument	Type	Description
after	integer	Cursor: only records with a version number greater than this. Omit for the first page; then pass next_after from the previous call. Stop when data is empty.
before	integer	Only records with a version number up to this (rarely needed).
deleted	boolean	true = include deleted records (default: active only).
page_size	integer	Records per page (the vendor default applies when omitted; 50-100 keeps replies short).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "after": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Cursor: only records with a version number greater than this. Omit for the first page; then pass next_after from the previous call. Stop when data is empty."
    },
    "before": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Only records with a version number up to this (rarely needed)."
    },
    "deleted": {
      "type": "boolean",
      "description": "true = include deleted records (default: active only)."
    },
    "page_size": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Records per page (the vendor default applies when omitted; 50-100 keeps replies short)."
    }
  }
}

lightspeedxseries_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.

read-only

Argument	Type	Description
after	integer	Cursor: only records with a version number greater than this. Omit for the first page; then pass next_after from the previous call. Stop when data is empty.
before	integer	Only records with a version number up to this (rarely needed).
deleted	boolean	true = include deleted records (default: active only).
page_size	integer	Records per page (the vendor default applies when omitted; 50-100 keeps replies short).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "after": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Cursor: only records with a version number greater than this. Omit for the first page; then pass next_after from the previous call. Stop when data is empty."
    },
    "before": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Only records with a version number up to this (rarely needed)."
    },
    "deleted": {
      "type": "boolean",
      "description": "true = include deleted records (default: active only)."
    },
    "page_size": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Records per page (the vendor default applies when omitted; 50-100 keeps replies short)."
    }
  }
}

lightspeedxseries_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.

read-only

Argument	Type	Description
sku	string	Exact SKU (other filters are ignored when set).
after	integer	Cursor: only records with a version number greater than this. Omit for the first page; then pass next_after from the previous call. Stop when data is empty.
includes	array	Related records to include. 'families' is required together with brands, categories, suppliers, tags, variant_attributes or customizations.
page_size	integer	Records per page (the vendor default applies when omitted; 50-100 keeps replies short).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "sku": {
      "type": "string",
      "maxLength": 100,
      "description": "Exact SKU (other filters are ignored when set)."
    },
    "after": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Cursor: only records with a version number greater than this. Omit for the first page; then pass next_after from the previous call. Stop when data is empty."
    },
    "includes": {
      "type": "array",
      "items": {
        "enum": [
          "families",
          "brands",
          "categories",
          "suppliers",
          "tags",
          "variant_attributes",
          "customizations",
          "composite_components"
        ],
        "type": "string"
      },
      "maxItems": 8,
      "description": "Related records to include. 'families' is required together with brands, categories, suppliers, tags, variant_attributes or customizations."
    },
    "page_size": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Records per page (the vendor default applies when omitted; 50-100 keeps replies short)."
    }
  }
}

lightspeedxseries_list_registers

List registers (tills): id, name, outlet_id, is_open, open/close times and invoice numbering. Paginate with next_after. GET /registers.

read-only

Argument	Type	Description
after	integer	Cursor: only records with a version number greater than this. Omit for the first page; then pass next_after from the previous call. Stop when data is empty.
before	integer	Only records with a version number up to this (rarely needed).
deleted	boolean	true = include deleted records (default: active only).
page_size	integer	Records per page (the vendor default applies when omitted; 50-100 keeps replies short).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "after": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Cursor: only records with a version number greater than this. Omit for the first page; then pass next_after from the previous call. Stop when data is empty."
    },
    "before": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Only records with a version number up to this (rarely needed)."
    },
    "deleted": {
      "type": "boolean",
      "description": "true = include deleted records (default: active only)."
    },
    "page_size": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Records per page (the vendor default applies when omitted; 50-100 keeps replies short)."
    }
  }
}

lightspeedxseries_list_sales

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.

read-only

Argument	Type	Description
after	integer	Cursor: only records with a version number greater than this. Omit for the first page; then pass next_after from the previous call. Stop when data is empty.
before	integer	Only records with a version number up to this (rarely needed).
page_size	integer	Records per page (the vendor default applies when omitted; 50-100 keeps replies short).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "after": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Cursor: only records with a version number greater than this. Omit for the first page; then pass next_after from the previous call. Stop when data is empty."
    },
    "before": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Only records with a version number up to this (rarely needed)."
    },
    "page_size": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Records per page (the vendor default applies when omitted; 50-100 keeps replies short)."
    }
  }
}

lightspeedxseries_list_suppliers

List suppliers: id, name, default markup and contact details. Paginate with next_after. GET /suppliers.

read-only

Argument	Type	Description
after	integer	Cursor: only records with a version number greater than this. Omit for the first page; then pass next_after from the previous call. Stop when data is empty.
before	integer	Only records with a version number up to this (rarely needed).
deleted	boolean	true = include deleted records (default: active only).
page_size	integer	Records per page (the vendor default applies when omitted; 50-100 keeps replies short).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "after": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Cursor: only records with a version number greater than this. Omit for the first page; then pass next_after from the previous call. Stop when data is empty."
    },
    "before": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Only records with a version number up to this (rarely needed)."
    },
    "deleted": {
      "type": "boolean",
      "description": "true = include deleted records (default: active only)."
    },
    "page_size": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Records per page (the vendor default applies when omitted; 50-100 keeps replies short)."
    }
  }
}

lightspeedxseries_list_tags

List product tags (id, name). Paginate with next_after. GET /tags.

read-only

Argument	Type	Description
after	integer	Cursor: only records with a version number greater than this. Omit for the first page; then pass next_after from the previous call. Stop when data is empty.
before	integer	Only records with a version number up to this (rarely needed).
deleted	boolean	true = include deleted records (default: active only).
page_size	integer	Records per page (the vendor default applies when omitted; 50-100 keeps replies short).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "after": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Cursor: only records with a version number greater than this. Omit for the first page; then pass next_after from the previous call. Stop when data is empty."
    },
    "before": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Only records with a version number up to this (rarely needed)."
    },
    "deleted": {
      "type": "boolean",
      "description": "true = include deleted records (default: active only)."
    },
    "page_size": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Records per page (the vendor default applies when omitted; 50-100 keeps replies short)."
    }
  }
}

lightspeedxseries_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.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

lightspeedxseries_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.

read-only

Argument	Type	Description
after	integer	Cursor: only records with a version number greater than this. Omit for the first page; then pass next_after from the previous call. Stop when data is empty.
before	integer	Only records with a version number up to this (rarely needed).
page_size	integer	Records per page (the vendor default applies when omitted; 50-100 keeps replies short).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "after": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Cursor: only records with a version number greater than this. Omit for the first page; then pass next_after from the previous call. Stop when data is empty."
    },
    "before": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Only records with a version number up to this (rarely needed)."
    },
    "page_size": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Records per page (the vendor default applies when omitted; 50-100 keeps replies short)."
    }
  }
}

lightspeedxseries_sales_summary

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.

read-only

Argument	Type	Description
state	string	Sale state. On-account and layby sales are state closed (they differ by attributes).
offset	integer	Offset for the next page: pass next_offset from the previous call (default 0).
date_to	string	Sales up to this UTC time. YYYY-MM-DD means the END of that UTC day (23:59:59Z).
user_id	string	Only sales by this staff user.
date_from	string	Sales from this UTC time. YYYY-MM-DD means the start of that UTC day; or 2026-10-01T00:00:00Z. Convert local days to UTC with the retailer's time zone.
max_pages	integer	Pages of page_size sales to read (default 5, max 20).

lightspeedxseries_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.

read-only

Argument	Type	Description
email	string
phone	string
mobile	string
offset	integer	Offset for the next page: pass next_offset from the previous call (default 0).
deleted	boolean	true = include deleted records (default: active only).
last_name	string
page_size	integer	Records per page (max 1000).
first_name	string
company_name	string
customer_code	string

lightspeedxseries_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.

read-only

Argument	Type	Description
sku	string	SKU filter (sent in lowercase, as the vendor search requires).
offset	integer	Offset for the next page: pass next_offset from the previous call (default 0).
tag_id	string	Tag id.
deleted	boolean	true = include deleted records (default: active only).
brand_id	string	Brand id.
page_size	integer	Records per page (max 1000).
supplier_id	string	Supplier id.
product_type_id	string	Product type id.
variant_parent_id	string	Only the variants of this parent product.

lightspeedxseries_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.

read-only

Argument	Type	Description
state	string	Sale state. On-account and layby sales are state closed (they differ by attributes).
offset	integer	Offset for the next page: pass next_offset from the previous call (default 0).
date_to	string	Sales up to this UTC time. YYYY-MM-DD means the END of that UTC day (23:59:59Z).
user_id	string	Only sales by this staff user.
date_from	string	Sales from this UTC time. YYYY-MM-DD means the start of that UTC day; or 2026-10-01T00:00:00Z. Convert local days to UTC with the retailer's time zone.
outlet_id	string	Only sales at this outlet.
page_size	integer	Records per page (max 1000).
product_id

lightspeedxseries_set_product_stock

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).

destructive

Argument	Type	Description
outlet_id*	string	Outlet id (from list_outlets).
product_id*	string	Product id (from list_products).
reorder_point	number	Re-order when stock falls to this level.
current_amount	number	New stock on hand at this outlet (the total, not a delta).
reorder_amount	number	How many to re-order.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "product_id",
    "outlet_id"
  ],
  "properties": {
    "outlet_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Outlet id (from list_outlets)."
    },
    "product_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Product id (from list_products)."
    },
    "reorder_point": {
      "type": "number",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Re-order when stock falls to this level."
    },
    "current_amount": {
      "type": "number",
      "maximum": 1000000,
      "minimum": 0,
      "description": "New stock on hand at this outlet (the total, not a delta)."
    },
    "reorder_amount": {
      "type": "number",
      "maximum": 1000000,
      "minimum": 0,
      "description": "How many to re-order."
    }
  }
}

lightspeedxseries_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}.

destructive

Argument	Type	Description
note	string
email	string
phone	string
mobile	string
last_name	string	Last name.
first_name	string	First name.
customer_id*	string	Customer id.
company_name	string
do_not_email	boolean

lightspeedxseries_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}.

destructive

Argument	Type	Description
product_id*	string	Product id (from list_products).
loyalty_amount	string	New loyalty amount.
price_excluding_tax	string	New price before tax, e.g. "24.99".
price_including_tax	string	New price including tax, e.g. "29.99".

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "product_id"
  ],
  "properties": {
    "product_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Product id (from list_products)."
    },
    "loyalty_amount": {
      "type": "string",
      "pattern": "^\\d{1,12}(\\.\\d{1,4})?$",
      "description": "New loyalty amount."
    },
    "price_excluding_tax": {
      "type": "string",
      "pattern": "^\\d{1,12}(\\.\\d{1,4})?$",
      "description": "New price before tax, e.g. \"24.99\"."
    },
    "price_including_tax": {
      "type": "string",
      "pattern": "^\\d{1,12}(\\.\\d{1,4})?$",
      "description": "New price including tax, e.g. \"29.99\"."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "size": {
      "type": "integer",
      "maximum": 500,
      "minimum": 1,
      "description": "Records per page (default 100, max 500 here)."
    },
    "offset": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Offset for the next page: pass next_offset from the previous call (default 0)."
    },
    "sort_type": {
      "enum": [
        "total_count",
        "total_cost",
        "average_cost",
        "reorder_point",
        "reorder_amount",
        "product_name",
        "created_at"
      ],
      "type": "string"
    },
    "outlet_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[A-Za-z0-9_-]{1,64}$",
        "description": "Outlet id."
      },
      "maxItems": 100,
      "description": "Only these outlets (the vendor calls them location_ids)."
    },
    "product_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[A-Za-z0-9_-]{1,64}$",
        "description": "Product id."
      },
      "maxItems": 100,
      "description": "Only these products. Not together with root_product_ids."
    },
    "supplier_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[A-Za-z0-9_-]{1,64}$",
        "description": "Supplier id."
      },
      "maxItems": 100
    },
    "group_variants": {
      "type": "boolean",
      "description": "Aggregate variant families when filtering by root_product_ids."
    },
    "sort_direction": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string"
    },
    "include_inactive": {
      "type": "boolean",
      "description": "true = include inactive products."
    },
    "root_product_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[A-Za-z0-9_-]{1,64}$",
        "description": "Root product id."
      },
      "maxItems": 100,
      "description": "Only these variant families (use with group_variants). Not together with product_ids."
    },
    "include_composites": {
      "type": "boolean"
    },
    "to_be_procured_only": {
      "type": "boolean",
      "description": "true = only products with a positive quantity_to_procure (not the same as below the reorder point)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "state": {
      "enum": [
        "parked",
        "pending",
        "voided",
        "closed"
      ],
      "type": "string",
      "description": "Sale state. On-account and layby sales are state closed (they differ by attributes)."
    },
    "offset": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Offset for the next page: pass next_offset from the previous call (default 0)."
    },
    "date_to": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}Z)?$",
      "description": "Sales up to this UTC time. YYYY-MM-DD means the END of that UTC day (23:59:59Z)."
    },
    "user_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Only sales by this staff user."
    },
    "date_from": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}Z)?$",
      "description": "Sales from this UTC time. YYYY-MM-DD means the start of that UTC day; or 2026-10-01T00:00:00Z. Convert local days to UTC with the retailer's time zone."
    },
    "max_pages": {
      "type": "integer",
      "maximum": 20,
      "minimum": 1,
      "description": "Pages of page_size sales to read (default 5, max 20)."
    },
    "outlet_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Only sales at this outlet."
    },
    "page_size": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 100,
      "description": "Sales per page (default 1000)."
    },
    "product_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Only sales containing this product."
    },
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Only sales to this customer."
    },
    "register_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Only sales on this register."
    },
    "counted_states": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 40
      },
      "maxItems": 10,
      "description": "Sale states that count towards the totals (exact, case-insensitive). Default: every state containing 'closed'."
    },
    "invoice_number": {
      "type": "string",
      "maxLength": 60
    },
    "payment_type_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Only sales with this payment type (the payment type's config_id, shown as payments[].type.config_id in a sale)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "state": {
      "enum": [
        "parked",
        "pending",
        "voided",
        "closed"
      ],
      "type": "string",
      "description": "Sale state. On-account and layby sales are state closed (they differ by attributes)."
    },
    "offset": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Offset for the next page: pass next_offset from the previous call (default 0)."
    },
    "date_to": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}Z)?$",
      "description": "Sales up to this UTC time. YYYY-MM-DD means the END of that UTC day (23:59:59Z)."
    },
    "user_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Only sales by this staff user."
    },
    "date_from": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}Z)?$",
      "description": "Sales from this UTC time. YYYY-MM-DD means the start of that UTC day; or 2026-10-01T00:00:00Z. Convert local days to UTC with the retailer's time zone."
    },
    "outlet_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Only sales at this outlet."
    },
    "page_size": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Records per page (max 1000)."
    },
    "product_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Only sales containing this product."
    },
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Only sales to this customer."
    },
    "register_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Only sales on this register."
    },
    "invoice_number": {
      "type": "string",
      "maxLength": 60
    },
    "payment_type_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Only sales with this payment type (the payment type's config_id, shown as payments[].type.config_id in a sale)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id"
  ],
  "properties": {
    "note": {
      "type": "string",
      "maxLength": 2000
    },
    "email": {
      "type": "string",
      "format": "email",
      "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
      "maxLength": 255
    },
    "phone": {
      "type": "string",
      "maxLength": 60
    },
    "mobile": {
      "type": "string",
      "maxLength": 60
    },
    "last_name": {
      "type": "string",
      "maxLength": 255,
      "description": "Last name."
    },
    "first_name": {
      "type": "string",
      "maxLength": 255,
      "description": "First name."
    },
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Customer id."
    },
    "company_name": {
      "type": "string",
      "maxLength": 255
    },
    "do_not_email": {
      "type": "boolean"
    },
    "customer_code": {
      "type": "string",
      "maxLength": 100,
      "description": "Unique customer code (generated when omitted on create)."
    },
    "date_of_birth": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}"
    },
    "physical_city": {
      "type": "string",
      "maxLength": 255
    },
    "enable_loyalty": {
      "type": "boolean"
    },
    "physical_state": {
      "type": "string",
      "maxLength": 255
    },
    "physical_suburb": {
      "type": "string",
      "maxLength": 255
    },
    "customer_group_id": {
      "type": "string",
      "maxLength": 64,
      "description": "Customer group id (see list_customer_groups)."
    },
    "physical_postcode": {
      "type": "string",
      "maxLength": 30
    },
    "physical_address_1": {
      "type": "string",
      "maxLength": 255
    },
    "physical_address_2": {
      "type": "string",
      "maxLength": 255
    },
    "physical_country_id": {
      "type": "string",
      "maxLength": 10,
      "description": "Country code such as US, CA, AU."
    },
    "enable_promotional_sms": {
      "type": "boolean"
    }
  }
}