Skip to content
Leat Help Center

Installing the Lightspeed K-Series integration

The Lightspeed K-Series integration lets your contacts earn points on every order and redeem rewards and vouchers while they order. This article covers installing it, adding Leat to your Lightspeed POS, setting up gift cards and prepaid, and the settings that decide how discounts are given.

Install the integration

  1. Sign in to the Business Dashboard, go to Apps and open Integrations.
  2. In the Marketplace, find Lightspeed K-Series and click Install.
  3. The Lightspeed login page opens in a new tab. Log in with your Lightspeed account. If the setup shows the Authenticate step instead, click Start authentication to open the login page.
  4. In Lightspeed, enable the requested resources financial-api, items and orders-api, then click Authorize. You're taken back to the Business Dashboard, where the setup continues.

The setup then takes you through 3 more steps: Configure, Health check and Data sync.

Configure

Link each Lightspeed location to a Business profile, then click Next. This decides which location a loyalty transaction is recorded against, so take care to get it right.

Health check

This step shows whether the connection works, your Real-time notification URL and a ready-made email. Lightspeed only sends your orders to Leat once its support team has turned on real-time notifications for that URL, so without this step your contacts don't earn points on their orders.

Click Send email to open the email in your email client, or copy its content into a new email, and send it to k-series.support@lightspeedhq.com. Then click Next.

Data sync

This step shows which data has been synced from Lightspeed and when it was last updated. To sync something again, click the reload icon next to it. Click Next to finish and open your Lightspeed K-Series integration. You can sync again later from the integration's Sync tab.

If a sync finds Lightspeed locations Leat didn't know yet, a popup shows New Lightspeed locations found with their names and a ready-made email asking Lightspeed to turn on real-time notifications for them. Click Send email, or copy the email and send it to k-series.support@lightspeedhq.com, then click Got it. Until Lightspeed has done this, orders from those locations don't reach Leat.

Once the integration is running, the Locations tab shows for each location whether its orders reach Leat. See Lightspeed K-Series settings: the Settings, Advanced and Locations tabs explained, which also covers adding a location later.

Add Leat to your Lightspeed POS

To let staff redeem rewards and vouchers at the till, add the Leat web extension to your POS and put a button for it on your menu.

  1. In your Lightspeed back office, go to Operations > Web extensions and click Add a new web extension.
  2. In the Business Dashboard, go to Apps → Integrations and open Lightspeed K-Series under Installed in the sidebar. On the Web Extensions tab, copy the All-in-One - Web extension URL.
  3. Paste that URL into the new web extension in Lightspeed, turn on Provide a JavaScript context to the loaded page and click Save.
  4. In the Lightspeed back office, go to Menu management > Menus and open the menu you want to add the button to.
  5. In the Main Screens section, click Add. Give it a name that tells your staff what it does, such as Loyalty, Rewards or Members, and style it as you like.
  6. Under the new menu item, click Add button and choose Web extension. Select the web extension you just created and click Add 1 button.
  7. Click Upload and reload devices.

Choose how discounts are given

The integration's Settings tab has a Discount strategy setting with 2 options:

  • Use Lightspeed discounts (the default): a reward or voucher is given as a discount you created in Lightspeed and linked to it in Leat.
  • Use negative price items: a reward or voucher is added to the order as a separate line with a negative price.

Click Save at the bottom of the tab to save a change.

If you choose Use negative price items, create the item that carries those lines. In your Lightspeed back office, go to Items, create an item with the SKU LEAT-DISCOUNT-ITEM and set its price type to Manually-entered negative price. Without it, redeeming a reward at the till fails.

Set up gift cards and prepaid

By default, Leat gift cards and prepaid balance are taken as a payment on the check. To make that work, add a payment method for them in your Lightspeed back office:

  1. Go to Configuration > Settings > Payment methods.
  2. Add a payment method, choose Other payment method as its type and set its code to LGC.
  3. Go to Configuration > Configurations. On each configuration, open the Payments tab and deselect the payment method you just created, so it doesn't show up as a separate payment method at checkout.
  4. To sell or top up gift cards or prepaid balance at the till, go to Items, create an item with the SKU LEAT-PRODUCT-ITEM and set its price type to Manually-entered price.
  5. Reload all devices so they pick up the new configuration.

If your fiscal setup can't book a gift card as a payment, go to the integration's Advanced tab and turn on Take gift card and prepaid balance off as a negative-price item. The balance then comes off the check as a line on the LEAT-DISCOUNT-ITEM item instead of as a payment on LGC. You need the LEAT-DISCOUNT-ITEM item with the price type Manually-entered negative price for this, as described above.

On the same Advanced tab, under Gift cards and prepaid, you can also choose whether staff can top up and redeem gift cards, and top up and pay with prepaid, on the POS.

Your Lightspeed K-Series integration is now ready to use. Next, link a discount to each reward and voucher you want to offer at the till.

Naming the Lightspeed discount

When you create a discount in Lightspeed to use with the integration, give it a name the integration can recognise:

  • no capital letters
  • no spaces
  • no special characters, such as @, $ or %

A name like leat_discount works. Names like Leat Discount or LEAT-Reward% can stop the integration from recognising the discount.

Other settings

The integration's Settings and Advanced tabs have more settings, for example to let staff look up a contact by email address, to decide whether staff can edit a contact's attributes, and to show an on-screen keyboard. Every setting is explained in Lightspeed K-Series settings: the Settings, Advanced and Locations tabs explained.

If something doesn't work after installing, see Lightspeed K-Series: Integration Troubleshooting.

Back to the help center