Retailer account details: name, currency, time zone, settings. Call this first if you need the currency or local time zone.

All outlets (stores/warehouses) with id, name, address and time zone.

All registers (tills) with their outlet and open/closed state.

Staff users (id, name, account type, outlets). Use ids with get_user_sale_totals or search_sales(user_id=...).

Payment types configured (cash, card, gift card, store credit, ...).

Sales taxes configured, with rates.

List a reference collection. kind is one of: brands, suppliers, tags, product_categories, product_types, variant_attributes, customer_groups, price_books, outlet_taxes, button_layouts.

Find products by name, variant name, SKU or barcode (case-insensitive; every word must match). Returns product_id, name, variant, SKU and retail prices. Follow with get_inventory(product_id) for stock or get_product for full detail.

One product with its family, brand, category, supplier, tags and variant attributes. Pass product_id, or sku to look it up by SKU.

The variant family a product belongs to (every colour/size of one item): family details, brand/category/tag names and one compact line per variant (id, variant name, SKU, retail price, active). full=True returns the raw API object (can be very large).

Raw product collection page (version cursor). Pass the previous response's version.max as after for the next page. Prefer search_products to find items.

Stock on hand per outlet for one product (variant), with reorder point/amount and average cost. include_variants=True covers its whole family (every colour and size; can be hundreds of rows). outlet filters by outlet name (substring). hide_zero drops rows with nothing on hand.

Inventory levels across the catalog, optionally filtered by outlets and products (on hand, available, allocated, on order where provided). Page with offset/size (size max 10000). Use for 'what's in stock at outlet X' or low-stock reviews.

Stock adjustments (manual corrections, damages, ...), version-cursor paged.

Stock orders/transfers/returns/stocktakes. type: SUPPLIER, OUTLET (transfer), RETURN or STOCKTAKE. status e.g. OPEN, SENT, DISPATCHED, RECEIVED, CANCELLED, STOCKTAKE_IN_PROGRESS. Version-cursor paged.

One consignment with its totals and (by default) its product lines.

Purchase orders (version-cursor paged).

One purchase order with its line items and deliveries.

Find sales. date_from/date_to are local store dates YYYY-MM-DD, inclusive (default: today). states: closed, pending (on account / layby), parked, voided (default: all). Compact rows by default; set compact=False for full line items, or call get_sale(id).

One sale in full: line items, payments, taxes, customer, totals.

Revenue totals for a local date range (YYYY-MM-DD, inclusive; default today). group_by: outlet, day, user, product, or none. Counts closed sales by default (pass states to change). Returns sales count, totals excl/incl tax, tax, units (product grouping) and average sale value. Returns are included as negatives. Capped at 20,000 sales per call: narrow the range if truncated is true.

A staff user's sales totals (as reported by Lightspeed).

Payment totals by payment type for a register's current/last session.

Quotes (sales:read), cursor paged with after.

Fulfillments (pickups/deliveries/shipping) with state, optionally by outlet or sale.

Find customers by email, name, company, phone or customer code.

One customer (contact details, group, loyalty balance, year-to-date spend) with addresses and, by default, store credit balance.

Customers in a customer group (version-cursor paged).

Store credit report across all customers.

A gift card by number, with balance, status and transactions.

Gift cards, optionally by status (e.g. ACTIVE, VOIDED).

Promotions. scope: current_upcoming (default), past or all. name matches part of the promotion name; outlet_ids keeps those linked to the given outlets.

One promotion with its rules, promo codes and applicable products (counts plus the first product_limit of each product list).

Prices in a price book (tax-exclusive): name, product_id, price, tax, markup. Filter by product_ids or query (name substring); capped at limit.

Read any other X-Series endpoint with GET, e.g. /shifts, /services, /serialnumbers, /auditlog_events, /customer_taxes, /product_images/{id}. path is relative to /api/ and must start with '/'. params are query parameters (lists repeat the key). Reference: https://x-series-api.lightspeedhq.com/llms.txt