Skip to main content

Lightspeed Retail

Read and update Lightspeed Retail (R-Series) items, inventory, sales, customers and shops.

Connect it with: Sign in (OAuth). Lightspeed Retail's own documentation: https://developers.lightspeedhq.com/retail/authentication/authentication-overview/.

What agents can do​

Connect Lightspeed Retail so the agents working your tasks can reach it. With it connected, they can:

  • Look up an item's price, stock on hand and reorder point across shops.
  • Find items below their reorder point and draft a purchase list.
  • Report sales by shop, register or employee for a day or a period.
  • Look up a customer and their purchase history when a task names them.

Before you start​

  • A Lightspeed Retail (R-Series) account. Lightspeed Retail X-Series (formerly Vend) and Lightspeed Restaurant are different products and cannot be connected here.
  • A Lightspeed employee login with the rights agents should have: agents act as that employee.
  • A Jaah account. Anyone can add a personal secret; an organization secret needs an Org Owner or Admin.

Connect with Lightspeed Retail​

This is the quickest way in: you sign in to Lightspeed Retail and approve what Jaah asks for. You never copy a key.

  1. In Jaah, open Secrets and select New.
  2. Search for Lightspeed Retail and select its card.
  3. Give the secret a name you will recognize, such as the account or workspace it reaches, and choose who can use it (see Who can use it).
  4. Select Connect Lightspeed Retail. Lightspeed Retail's sign-in window opens.
  5. Sign in to Lightspeed Retail if asked, check the access listed, and approve it.
  6. You land back in Jaah on the new secret, which reads Connected once its test passes.

If the button reads Jaah app not configured, this Jaah has no app registered at Lightspeed Retail yet. Use your own OAuth app until it does (see Use your own OAuth app).

Scopes Jaah requests​

Jaah asks Lightspeed Retail for these scopes, and no others. A scope marked optional is a checkbox on the Connect screen: untick it and agents simply cannot do that part.

ScopeWhy Jaah asks for itRequired
employee:allAct as the employee who connects, with that employee's rights, so agents can read and update items, inventory, sales and customersYes

Connect with an API key​

Lightspeed Retail has no API key option in Jaah: connect with the sign-in above.

Use your own OAuth app​

Register your own OAuth app at Lightspeed Retail when your company requires apps it controls, or before this Jaah has an app registered there.

  1. Create an OAuth app in Lightspeed Retail's developer console, https://cloud.lightspeedapp.com/oauth/register.php (Lightspeed Retail's documentation).
  2. Set its redirect URI to https://app.jaah.ai/api/credentials/connect/callback (on your own Jaah, its console address followed by /api/credentials/connect/callback).
  3. Give it the scopes in Scopes Jaah requests.
  4. Copy its client ID and client secret.
  5. In Jaah, start a new Lightspeed Retail secret, select Use your own OAuth app, paste both values and select Connect Lightspeed Retail.

The client secret is stored with the connection, encrypted, like any other secret value.

Test the connection​

Select Test on the secret. Jaah calls Lightspeed Retail's API once (GET https://api.lightspeedapp.com/API/V3/Account.json) with the stored values, and shows who it answered as, or which value Lightspeed Retail refused and the status it answered. Jaah also tests automatically when you save or reconnect.

The last result and its time stay on the secret's page, so you can see whether it still works without testing again.

Who can use it​

Every secret has an owner, and the owner decides who can use it:

  • Personal — only your own tasks can use it. This is the default.
  • Organization — every task in the organization can use it. Only Org Owners and Admins can choose this.
  • Attached to a project — every task on that project can use it, whoever started the task. See Attach a secret to a project.

More on owners and access: How secrets work.

Use it in an agent session​

An agent asks for the secret with its credential_get tool, by the secret's path, when it needs it, and gets the values for that one call. The path is the owner's prefix and the secret's name:

  • org/<name> for an organization secret,
  • projects/<project>/<name> for one attached to a project,
  • me/<name> for your personal one.

A signed-in connection hands the agent a live access_token, with access_token_expires_at. Jaah refreshes it before it expires, so an agent never handles a refresh token.

Tell the agent in your task description which secret to use, for example “use the Lightspeed Retail secret org/lightspeed”.

Manage, rotate or disconnect​

Everything is on the secret's page under Secrets:

  • Reconnect: when Lightspeed Retail ends the grant (a password change, a revoked app, an expired refresh), the secret shows Needs reconnect. Select Reconnect and sign in again; agents get the new token on their next call.
  • Disconnect: select Delete. The stored values are destroyed and agents lose access on their next call. To end access at Lightspeed Retail's side too, revoke Jaah in Lightspeed Retail's settings.

Limitations​

  • Lightspeed Retail X-Series, Restaurant and eCom are not supported: each signs in at a per-store address this connection cannot use yet.
  • Agents act as the employee who connected, with that employee's rights in Lightspeed.
  • Lightspeed meters each account's API use with a leaky bucket (about one request a second sustained); bulk work is slowed down, not refused.
  • Agents can do only what the connected Lightspeed Retail account and its granted scopes allow.

Troubleshooting​

The secret shows Needs reconnect

The employee who connected was removed or changed their password, or Jaah was revoked in Lightspeed. Select Reconnect and sign in as an active employee.

Test says Lightspeed Retail rejected the access token (401)

The grant was revoked. Select Reconnect and sign in to Lightspeed again.

Signing in fails with a redirect URI error

Your own OAuth app's redirect URI does not match Jaah's exactly. Correct it with Lightspeed's update form, or leave the client fields blank to use Jaah's app.

Still stuck? Select Test and read the result: it names the value Lightspeed Retail refused and the status it answered.

FAQ​

I use Lightspeed X-Series (formerly Vend). Can I connect it?

Not yet. X-Series signs in at an address that differs for every store, which this connection does not support.

Does Test change anything?

No. It reads your Lightspeed account's name and nothing else.

Can Jaah or an admin see the key or token?

No. Jaah stores it encrypted and never shows it again. Only the tasks allowed to use the secret receive it, at the moment they ask for it.

Can I connect more than one Lightspeed Retail account?

Yes. Add one secret per account, each with its own name, and tell the agent which one to use.