Connect Lightspeed Restaurant (K-Series)

A step-by-step guide with pictures, from the Speakvora agent's own Connect tab.

Short answer: This connects your own Lightspeed account to your Speakvora agent. Then a customer can text where is order 1234 and get the answer in seconds, and the agent can send status and tracking texts. The agent only reads. It can never create, change or delete anything in Lightspeed. Only the status word and the order number.

Every key, number and name in the pictures is a made-up example. Nothing here asks you to share a real key with anyone but the app on your own computer.

This connects your own Lightspeed account to your Speakvora agent. Then a customer can text *where is order 1234* and get the answer in seconds, and the agent can send status and tracking texts. The agent only reads. It can never create, change or delete anything in Lightspeed. Only the status word and the order number are ever texted back, never names, prices, items or addresses.

TIP: You need about 15 minutes, a computer, and the sign-in for your Lightspeed account (the owner or a manager). You can't break anything: if a step does not work, nothing has changed and you can just try again. The keys and screens below are made-up examples.

NOTE: This guide was written from Lightspeed's public developer documentation (a few details could not be confirmed) and has not been tried yet on a live Lightspeed account. If a screen looks different from what is described, press Connect, then Download report, and send it to support. We fix it for everyone.

Who this is for: restaurants food. How Lightspeed gives access: The vendor only gives API access after an approval or a business agreement. Ask them first (steps below); until then use the no-API options at the end. What it costs you: Cost of API access is not stated in Lightspeed's public developer pages.

Part 1. Get your key from Lightspeed

Do this on your computer, in a new browser tab, signed in to Lightspeed.

  1. Sign in to your Lightspeed Restaurant Back Office as the owner.
  2. Contact your Lightspeed account manager or Lightspeed Support, and say you want API access for an integration partner.
  3. Ask for read-only access to orders (the orders-api scope), for your production account only.
  4. Ask Lightspeed which production API address and which check or order lookup to use.
  5. Wait for Lightspeed to approve and send you the client ID and client secret.
  6. Enter the client ID and client secret in Speakvora when they arrive.

WARNING: If Lightspeed asks which permissions to give, tick only the read-only ones: orders-api scope (read orders, payments, business info). Never give write or admin access.

TIP: To copy the key, click inside the box that shows it, press Command + C on a Mac or Ctrl + C on Windows (or right-click and choose Copy). Nothing will look different. It is now in your clipboard, ready to paste. Keep it private: anyone who has it can read your orders.

Part 2. Open the Connect tab in your agent

  1. Open your agent's dashboard (the page you open from the Start Speakvora Agent file).
  2. Press Connect in the menu. On a phone the menu is the bar along the top; slide it sideways if you do not see Connect.
  3. Step 1: press Connect (1)

  4. Under Your apps type Lightspeed in the box that says Find an app (1), or scroll down the list.
  5. Step 2: the Find an app box (1)

  6. Press Lightspeed Restaurant (K-Series). A card slides up. (If you only see apps for your own kind of business, that is on purpose: your agent only shows the systems that make sense for it.)
  7. Step 3: an app's card. The Full Guide button (1) opens this page.

Part 3. Paste it in

2 boxes to fill in. Click inside a box, press Command + V on a Mac or Ctrl + V on Windows, then move to the next:

  1. API client ID from Lightspeed. The client ID Lightspeed gives you after your API access request is approved.
  2. API client secret from Lightspeed (secret: it stays on this computer and is never shown again, only the last few characters). The client secret that comes with the client ID. Lightspeed uses OAuth 2.0 with the orders-api scope.
  3. Part 3: each numbered box is one thing to paste. These are made-up examples.

TIP: Pasted by mistake into the wrong box? Click the box, press Command + A (Ctrl + A on Windows) to select all, then paste again.

Part 4. Test it

  1. Press the orange Save and test button.
  2. Lightspeed has no safe read-only check we can run, so nothing is called. The connection is used for real the first time a customer asks about an order, and any problem shows in Activity.
  3. Part 4: the green message under the buttons means it worked (1)

YOU SHOULD SEE: green words starting with Connected. (here: *Saved* and the sentence about the first customer)

WARNING: Red words mean it did not work yet. Read them, then see If something is wrong below. Nothing bad happened.

What happens next

  • A customer texts something like where is order 1234. The agent answers *Your order 1234 is preparing.* (the status word from Lightspeed), or *I could not find that order. A team member will check and reply.*
  • Each person can ask five times an hour. If Lightspeed is down, the conversation carries on and the problem is written to Activity.
  • Mode: the agent asks Lightspeed when a customer asks.

If something is wrong

  • It says the key was refused (401 or 403): copy the key again from Lightspeed. Make sure there is no space before or after it, and that it is a live key for the right shop or location.
  • It cannot find an order (404): the number is not in Lightspeed, or Lightspeed uses a longer number than the one on the receipt.
  • It says too many requests (429): wait a minute and press Save and test again.
  • Lightspeed says you need a plan or approval: Lightspeed K-Series uses OAuth 2.0 authorization code with scopes such as orders-api. API clients are issued by Lightspeed and are bound to either the trial or the production environment. The public pages read did not state the production API base URL, a cheap test call, or the exact call that reads one order by number, so no test or order call is given.
  • Still stuck? Press Connect, then Download report, and email it to support. It never contains keys or customer messages.

If your plan has no API

  • Ask your Lightspeed account manager or Lightspeed support to grant read-only orders access
  • Export order reports from Back Office and share them manually

Lightspeed's own instructions: https://api-docs.lsk.lightspeed.app/

All help guides · Every agent feature · AI receptionist by industry

Questions

What if this happens: It says the key was refused (401 or 403)?

copy the key again from Lightspeed. Make sure there is no space before or after it, and that it is a live key for the right shop or location.

What if this happens: It cannot find an order (404)?

the number is not in Lightspeed, or Lightspeed uses a longer number than the one on the receipt.

What if this happens: It says too many requests (429)?

wait a minute and press Save and test again.

What if this happens: Lightspeed says you need a plan or approval?

Lightspeed K-Series uses OAuth 2.0 authorization code with scopes such as orders-api. API clients are issued by Lightspeed and are bound to either the trial or the production environment. The public pages read did not state the production API base URL, a cheap test call, or the exact call that reads one order by number, so no test or order call is given.

What if this happens: Still stuck??

Press Connect, then Download report, and email it to support. It never contains keys or customer messages.