AI agents for Lightspeed Retail (X-Series)

Get store details

Reads the store's own settings: name, domain_prefix, currency, timezone, country, whether prices include tax (tax_exclusive), loyalty and store credit settings.

List outlets

Lists the store's outlets (locations).

Search sales

Finds sales, newest first, between two times, and optionally only at one outlet, for one customer or product, in one state.

Get a sale

Reads one sale by ID: invoice_number, date, state, customer_id, note, line_items (product name and SKU, quantity, price, discount, tax), payments (type, amount, date), taxes and totals.

List products

Lists products in version order, or the one product with a given SKU.

Get a product

Reads one product by ID with its family (name, description, classification), SKU, variant name, prices, barcodes, suppliers and images.

Get a product's stock levels

Reads how many of a product are on hand at each outlet.

Find customers

Finds customers by email, phone, mobile, first or last name, company or customer code.

Create a customer

Adds a customer with a first and last name and optionally email, phone, mobile, company, customer code, note, and whether to skip marketing email.