Lightspeed Retail connector for AI agents

Tools your retail agent reaches for on Lightspeed Retail, scoped per user.

CALL ANY TOOL

113 tools for retail in Lightspeed Retail: manage products, brands, and price books, check inventory levels, read and create sales and returns, and manage customers, gift cards, store credit, consignments, and suppliers.

lightspeedretail_add_consignment_product

Add consignment product

Add a product to the given consignment. Returns a data object with cost, count, created_at, deleted_at, is_included, product_id, product_sku, received. Use list_consignment_products to browse or filter, update_consignment_product to change an existing one, delete_consignment_product to remove one instead when that fits better.

Parameters

Name

Type

Required

Description

consignment_id

string

Required

The consignment id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.

data

object

Required

The data. Fields include cost, count, created_at, deleted_at, is_included, product_id, product_sku, received, status, updated_at. Example: {"cost": "Example cost", "count": "Example count", "created_at": "2026-10-01T00:00:00Z", "deleted_at": "2026-10-01T00:00:00Z", "is_included": true, "product_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5"}.

lightspeedretail_create_brand

Create brand

lightspeedretail_create_customer_address

Create customer address

lightspeedretail_create_gift_card_transaction

Create gift card transaction

lightspeedretail_create_sale

Create sale

Create a sale. Returns a data object with id. Use list_sales to browse or filter, get_sale to fetch one by ID, update_sale to change an existing one instead when that fits better.

Parameters

Name

Type

Required

Description

source

object

Required

The source. Fields include author_id, id, register_id, type. Example: {"author_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "id": "Example id", "register_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "type": "Example type"}.

state

string

Required

State of the sale. Allowed values: parked, pending, voided, closed. Example: closed. One of: `parked`, `pending`, `voided`, `closed`.

accounts_transaction_id

string

Optional

Xero invoice reference ID. Only editable for ONACCOUNT sales. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.

attributes

array

Optional

An array of attributes. Example: ["Example attributes"].

customer_id

string

Optional

The ID of the customer associated with this sale. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.

date

string

Optional

The date of the sale in RFC3339 format. If not provided will be added as the time the sale reached the server. Example: 2009-11-10T23:00:00Z.

fulfillment_details

array

Optional

Fulfillment details for DISPATCH or PICKUP fulfillments. Fields include note, shipping_address_id, shipping_address_token, type. Example: [{"note": "Example note", "shipping_address_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "shipping_address_token": "Example shipping address token", "type": "DISPATCH"}].

fulfillment_outlet_id

string

Optional

The default outlet that should fulfill this sale when a line item does not specify its own fulfilment_outlet_id. Mutually exclusive with pick lists created via /sales/{sale_id}/pick_lists. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.

string

Optional

User-provided sale ID. If not included, one will be generated. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.

invoice_number

string

Optional

The invoice number for the sale. If left null it will be populated by Lightspeed with the next available invoice number. Example: Example invoice number.

line_items

array

Optional

Line items. Fields include _metadata, attributes, fulfilment_outlet_id, id, pricing, product, quantity, source, status, tax. Example: [{"_metadata": {"fulfillment_method": "DISPATCH", "is_price_override": true, "sequence": 1}, "attributes": [{"name": "Example name", "value": "Example value"}], "fulfilment_outlet_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "id": "0af7b....

note

string

Optional

A note on the sale entered by the cashier. Example: Example note.

payments

array

Optional

Payments. Fields include amount, billing_address_id, billing_address_token, date, id, source, type. Example: [{"amount": 9.99, "billing_address_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "billing_address_token": "Example billing address token", "date": "2026-10-01T00:00:00Z", "id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "source": {"register_....

pricing

object

Optional

The pricing. Fields include adjustments. Example: {"adjustments": [{"amount": {"type": "FIXED", "value": "Example value"}, "name": "Example name", "source": {"id": "0af7b240-ab83-11e7-eddc-4023c64c85e5"}, "type": "NON_CASH_FEE"}]}.

service_fields

object

Optional

The service fields. Fields include service_action, service_agenda, service_items, service_line_items. Example: {"service_action": "Example service action", "service_agenda": {"date": "2026-10-01T00:00:00Z", "minutes_scheduled": 1}, "service_items": {"location": "Example location"}, "service_line_items": [{"_metadata": {"fulfillment_method": "DISP....

short_code

string

Optional

Short, unique code to be printed on the receipt for loyalty tracking purposes. Example: Example short code.

lightspeedretail_create_supplier

Create supplier

lightspeedretail_delete_brand

Delete brand

lightspeedretail_delete_customer_address

Delete customer address

lightspeedretail_get_brand

Get brand

lightspeedretail_get_custom_field_values

Get custom field values

lightspeedretail_get_customer_store_credit_balance

Get customer store credit balance

lightspeedretail_get_price_book

Get price book

lightspeedretail_get_quote

Get quote

lightspeedretail_get_sale

Get sale

lightspeedretail_get_tax

Get tax

lightspeedretail_list_all_price_book_products

List all price book products

lightspeedretail_list_custom_fields

List custom fields

lightspeedretail_list_customer_groups

List customer groups

lightspeedretail_list_payment_types

List payment types

lightspeedretail_list_product_inventory_levels

List product inventory levels

lightspeedretail_list_promotion_products

List promotion products

lightspeedretail_list_purchase_orders

List purchase orders

lightspeedretail_list_serial_numbers

List serial numbers

lightspeedretail_list_suppliers

List suppliers

lightspeedretail_return_sale

Return sale

lightspeedretail_search_inventory_levels

Search inventory levels

Return a paginated list of inventory levels. Returns an array of objects with average_cost, brand_id, current_inventory_level, location_id, name, product_id, product_type_id, quantity_to_procure. Use list_product_inventory_levels to browse or filter instead when that fits better.

Parameters

Name

Type

Required

Description

group_variants

boolean

Optional

If filtering by root_product_ids and group_variants is true, one aggregated level will be returned for each variant family at each outlet. Example: true.

include_composites

boolean

Optional

Include composite products in the response. Example: true.

include_inactive

boolean

Optional

Include inactive products in the response. Example: true.

location_ids

array

Optional

Optional outlet IDs to filter response by. Example: ["0af7b240-ab83-11e7-eddc-4023c64c85e5"].

offset

integer

Optional

How many inventory levels to skip. Example: 0.

product_ids

array

Optional

Optional product IDs to filter response by. Mutually exclusive with root_product_ids. When omitted, returns inventory levels for all products. Example: ["0af7b240-ab83-11e7-eddc-4023c64c85e5"].

root_product_ids

array

Optional

Optional root product IDs to filter response by. Mutually exclusive with product_ids. When omitted, returns inventory levels for all products. Example: ["0af7b240-ab83-11e7-eddc-4023c64c85e5"].

size

integer

Optional

How many inventory levels to return. Example: 100.

sort_direction

string

Optional

Whether to sort the response ascending or descending. Allowed values: asc, desc. Example: asc. One of: `asc`, `desc`.

sort_type

string

Optional

Which response field to sort by. Allowed values: total_count, total_cost, average_cost, reorder_point, reorder_amount, product_name, created_at. Example: total_count. One of: `total_count`, `total_cost`, `average_cost`, `reorder_point`, `reorder_amount`, `product_name`, `created_at`.

supplier_ids

array

Optional

Optional supplier IDs to filter response by. Example: ["0af7b240-ab83-11e7-eddc-4023c64c85e5"].

to_be_procured_only

boolean

Optional

Only include inventory with a positive quantity to procure. Example: true.

lightspeedretail_set_custom_field_values

Set custom field values

lightspeedretail_update_brand

Update brand

lightspeedretail_update_customer_address

Update customer address

lightspeedretail_update_sale

Update sale

Update an existing sale by ID. Returns a data object with _metadata, adjustments, attributes, created_at, customer_id, date, deleted_at, ecom_custom_charges. Use list_sales to browse or filter, get_sale to fetch one by ID, create_sale to add a new one instead when that fits better.

Parameters

Name

Type

Required

Description

sale_id

string

Required

A valid sale ID. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.

source

object

Required

state

string

Required

State of the sale. Allowed values: parked, pending, voided, closed. Example: closed. One of: `parked`, `pending`, `voided`, `closed`.

accounts_transaction_id

string

Optional

Xero invoice reference ID. Only editable for ONACCOUNT sales. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.

attributes

array

Optional

An array of attributes. Example: ["Example attributes"].

customer_id

string

Optional

The ID of the customer associated with this sale. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.

date

string

Optional

The date of the sale in RFC3339 format. If not provided will be added as the time the sale reached the server. Example: 2009-11-10T23:00:00Z.

fulfillment_details

array

Optional

fulfillment_outlet_id

string

Optional

invoice_number

string

Optional

The invoice number for the sale. If left null it will be populated by Lightspeed with the next available invoice number. Example: Example invoice number.

line_items

array

Optional

note

string

Optional

A note on the sale entered by the cashier. Example: Example note.

payments

array

Optional

pricing

object

Optional

service_fields

object

Optional

short_code

string

Optional

Short, unique code to be printed on the receipt for loyalty tracking purposes. Example: Example short code.

For more tools, view docs.

Build your Agent

Same auth pattern across LangChain, OpenAI, Anthropic, and Google ADK.

import { ScalekitClient } from "@scalekit-sdk/node";
import { createReactAgent } from "@langchain/langgraph/prebuilt";

const sk = new ScalekitClient(env.SCALEKIT_ENV_URL, env.SCALEKIT_CLIENT_ID, env.SCALEKIT_CLIENT_SECRET);

// Lightspeed Retail tools scoped to this user
const { tools } = await sk.tools.listScopedTools("user_123", {
  filter: { connectionNames: ["lightspeedretail"], toolNames: [
    "lightspeedretail_list_products",
    "lightspeedretail_list_product_inventory_records",
    "lightspeedretail_create_stock_adjustments"] },
  pageSize: 100,
});

const agent = createReactAgent({ llm, tools });
await agent.invoke({ messages: [{ role: "user", content: "Check Classic Tee stock at every outlet" }] });

import OpenAI from "openai";
import { ScalekitClient } from "@scalekit-sdk/node";

const sk = new ScalekitClient(env.SCALEKIT_ENV_URL, env.SCALEKIT_CLIENT_ID, env.SCALEKIT_CLIENT_SECRET);
const openai = new OpenAI();

const { tools } = await sk.tools.listScopedTools("user_123", {
  filter: { connectionNames: ["lightspeedretail"] }, pageSize: 100,
});

const res = await openai.chat.completions.create({
  model: "gpt-5",
  messages: [{ role: "user", content: "Check Classic Tee stock at every outlet" }],
  tools,
});

// Execute the tool call with the user's vaulted Lightspeed Retail access token
await sk.tools.executeTool(res.choices[0].message.tool_calls[0], "user_123");

import Anthropic from "@anthropic-ai/sdk";
import { ScalekitClient } from "@scalekit-sdk/node";

const sk = new ScalekitClient(env.SCALEKIT_ENV_URL, env.SCALEKIT_CLIENT_ID, env.SCALEKIT_CLIENT_SECRET);
const anthropic = new Anthropic();

const { tools } = await sk.tools.listScopedTools("user_123", {
  filter: { connectionNames: ["lightspeedretail"] }, pageSize: 100,
});

const msg = await anthropic.messages.create({
  model: "claude-sonnet-5",
  max_tokens: 1024,
  messages: [{ role: "user", content: "Check Classic Tee stock at every outlet" }],
  tools,
});

// Tool call runs with the user's vaulted Lightspeed Retail access token
await sk.tools.executeTool(msg.content, "user_123");

import { Agent } from "@google/adk/agents";
import { ScalekitClient } from "@scalekit-sdk/node";

const sk = new ScalekitClient(env.SCALEKIT_ENV_URL, env.SCALEKIT_CLIENT_ID, env.SCALEKIT_CLIENT_SECRET);

const { tools } = await sk.tools.listScopedTools("user_123", {
  filter: { connectionNames: ["lightspeedretail"] }, pageSize: 100,
});

const agent = new Agent({
  name: "retail_agent",
  model: "gemini-2.5-pro",
  instruction: "Lightspeed Retail tools scoped to this user",
  tools,
});

await agent.run("Check Classic Tee stock at every outlet");

Try these prompts

Copy any prompt into your agent. Each maps directly to a Lightspeed Retail tool. Click to copy, paste into your agent, done.

Products and stock

Copy the prompt

Copied

How many Classic Tee units do we have at each outlet?

Copy the prompt

Copied

Create a product called Linen Shirt under the Harbor brand.

Copy the prompt

Copied

List the stock adjustments made this week.

Sales

List today's sales.

Start a return for sale 10458.

Copy the prompt

Copied

Show payment totals for the downtown register.

Customers and loyalty

Copy the prompt

Copied

Find the customer with email jordan@example.com.

Copy the prompt

Copied

What is Jordan's store credit balance?

Copy the prompt

Copied

Create a $50 gift card for Jordan.

SEE HOW AUTH WORKS

Each user connects their own Lightspeed Retail access token once, and Scalekit sends it with every call. Tokens stay vaulted, every call is scope checked, and every action is logged.

Authorize

Your user connects

Lightspeed Retail

once. We tie it to their identity and the meetings they approved — no shared bot account, no org-wide access

Who:

user ‘A’

when:

Once per user

access:

Limited to user

Store

Their

Lightspeed Retail

token lives in a vault scoped to them. User A's meetings are never reachable by an agent acting for user B, even on the same connection

vault:

encrypted

scope:

per-user

tokens:

auto-refreshed

Resolve

When your agent calls a

Lightspeed Retail

tool, we fetch the right token server-side. It never touches your agent, never appears in the LLM context, never shows up in your logs

speed:

~40ms

check:

before every call

seen by:

nobody

Audit

Every

Lightspeed Retail

tool call is logged — who triggered it, which meeting was fetched, what came back. 90 days of history, tied to the user who authorized it

history:

90 days

export:

SIEM-ready

logged:

every call

Test other agents

See the same per-user auth pattern across other sales and commerce connectors.

GTM and RevOps Teams

CRM AI agent

Reads the Granola transcript after every call, extracts next steps and updates the HubSpot record, drafts the follow-up in Gmail, and confirms in Slack, all on the rep's own delegated OAuth.

GTM and RevOps Teams

Revenue forecast commentary

Pulls open pipeline from Salesforce and HubSpot, calculates coverage against quota, flags at-risk stages, posts commentary to Slack, and logs every snapshot to Google Sheets.

Why Scalekit

Secure your agent's access. Connectors ship in minutes

01.

Shared tokens break per-user analytics

A shared Lightspeed Retail access token looks fine in a demo. In production every sale and stock change looks like one service account, and you cannot tell which user triggered it. Scalekit resolves the credential of the actual user who triggered the agent, never a shared bot.

// shared token
audit → bot_service_account

// scalekit
audit → user_abc ✓

02.

Authentication is not authorization

03.

Multi-tenancy is architectural

04.

Lightspeed Retail today. Ten connectors tomorrow.

“Our agents act across Salesforce, Gong, Google Drive, and more, on behalf of every customer. Scalekit behind the scenes meant we can keep adding tools without ever rebuilding how credentials or tool calling work.”

Venu Madhav Kattagoni

Head of Engineering / Von

FAQs

Frequently Asked Questions

Does the agent access Lightspeed Retail as the user or through a shared access token?

As the user. Each user connects their own Lightspeed Retail access token once, and Scalekit sends it with every call. Audit logs attribute every sale, stock change, and customer update to that user, not a shared service account.

Where is the Lightspeed Retail access token stored?

In Scalekit's managed AES-256 token vault, namespaced per tenant. To rotate it, the user reconnects with a new access token. Revocation is a single dashboard action. Credentials never appear in prompts, logs, or LLM context.

Can I limit what the agent does in Lightspeed Retail?

Yes. Filter by tool name in listScopedTools to expose only what you want, for example product and sales lookups without lightspeedretail_delete_product or lightspeedretail_delete_customer. Scalekit also enforces scope checks before every API call.

What happens when a user revokes Lightspeed Retail access?

The connection is invalidated on the next tool call. Subsequent requests for that user fail closed with a clear error. Other users in the tenant remain unaffected. The event is logged for audit.

Can the agent take sales and returns in Lightspeed Retail?

Only if you expose those tools. lightspeedretail_create_sale creates a sale, lightspeedretail_return_sale starts a return for a closed sale, and lightspeedretail_update_sale changes an existing one. Leave them out to keep the agent to reporting on products, sales, and inventory.