Installing the Lightspeed X-Series integration

Lightspeed X-Series is Lightspeed’s retail POS. Connecting it to Leat lets your contacts earn points on what they buy in store, redeem rewards, vouchers and full stamp cards at the till, and buy or pay with gift cards there.

This article covers installing and configuring the integration. Once it’s running, you still need to set up how each reward and voucher behaves at the till. That’s covered in Setting up reward and voucher discounts for Lightspeed X-Series.

Before you start

Connect with a Lightspeed account that can manage your whole store, such as an administrator account. Leat asks Lightspeed for access to read and change your products, outlets, rules, custom fields, customers and webhooks, and to read your registers, sales and taxes. During setup it creates products, rules, custom fields and webhooks in your store, so the account needs to be allowed to do that.

Install the integration

1. Sign in to the Business Dashboard.
2. Go to Apps > Integrations.
3. Open Lightspeed X-Series in the marketplace and click Install.

Lightspeed opens in a new tab. Sign in and grant Leat access, and Lightspeed brings you back to the setup flow in Leat. The flow has 5 steps: Authenticate, Store information, Configure, Data sync and Health check.

Authenticate

You normally skip this step, because you already granted access after clicking Install. If the flow does open here, click Start authentication, sign in to Lightspeed and grant Leat access.

Store information

Under Store name, fill in your store name. That’s the part of your Lightspeed URL before .retail.lightspeed.app. If your URL is storename.retail.lightspeed.app, your store name is storename.

Then choose which functionalities to use. There are 2, and you can turn on either or both:

• Loyalty: contacts earn points through order rules and can redeem rewards and vouchers at the till.
• Giftcards: gift cards can be sold at the till and used to pay.

Click Next. You can change your choice later on the integration’s Settings tab, so turning on only loyalty now doesn’t lock you out of gift cards.

Configure

For each Lightspeed location, choose the matching Business profile in Leat, then click Next. This decides which location a transaction is recorded against, so take care to get it right.

Data sync

The data sync starts by itself the first time you reach this step. It brings 4 things into line between Lightspeed and Leat:

• Your outlets
• Your registers
• Your products
• Your contacts, which are created as customers in Lightspeed

Each item shows its status and when it last finished. To run one again, click the refresh icon next to it. Click Next when everything looks good.

You can sync again at any time from the integration’s Sync tab with Sync items & discounts. Do that whenever you add products in Lightspeed that a reward needs to point at.

Health check

The health check sets up what Leat needs in your Lightspeed store, such as rules, custom fields, products and webhooks, and checks that each part works. It starts by itself when you reach this step and fills in as each check finishes, with a green or red dot, a message and when it was last checked.

Click Finalize to finish. That turns the integration on and takes you to its page.

If a check stays red, read its message and check that the Lightspeed account you connected with is allowed to manage products, rules and webhooks. Then run the checks again from the integration’s General tab by clicking the refresh icon next to Health check. If a check still fails, contact Leat support.

After the integration is installed

Set up how contacts earn points: go to Loyalty > Earn rules and click Open rules on the Orders card. Lightspeed X-Series reports each sale to Leat as an order, so the rules under Order rules are the ones that apply.

Then set up the discount for each reward and voucher you want to offer at the till, as described in Setting up reward and voucher discounts for Lightspeed X-Series.

Stamp cards

If you use stamp cards, the register can redeem a contact's full card. It offers cards from 1 stamp card program: the one you link to the integration.

1. Open the integration’s Settings tab.
2. With Loyalty on, pick the stamp card under Stamp card program. None offers no stamp cards at the register.
3. Click Save.

The register skips the stamp card while it’s inactive. The Stamp card program select only shows when stamp cards are switched on for your account.

When the cashier adds a contact with a full card to a sale, the register asks “A stamp card is full!” and whether to redeem it now. On Yes, the stamp card’s reward goes on the sale as a discount, so the free item has to be on the sale already. If it isn’t, the register says the discount isn’t applicable. The stamps are only taken off once the sale is paid. If the sale is abandoned, the card stays full.

See Stamp cards: setting one up and how contacts collect stamps for setting up the card and its reward.

Gift cards

If you turned on gift cards during setup, Leat has already set them up in your Lightspeed store. On the integration’s Settings tab, Gift card handling upon purchase decides what happens when a cashier sells a gift card and enters its code:

• Use already created / imported giftcards (Recommended, and the default): the code must already exist in Leat, for example on a card you created or imported. The till turns down a code Leat doesn’t know with “The provided code was invalid”.
• Create new gift cards: the code must be new. The till turns down a code that already exists with “The provided code already exists.”
• Find existing card or create a new one: either works.

If the code belongs to a card that can’t be used this way, the till shows “This giftcard is not upgradeable.” and asks for another code.

A sale can hold 1 Leat gift card. If the cashier adds a second one, the till removes it and shows “One giftcard per sale”. Complete the sale, then start a new sale for the next gift card.

If you didn’t turn on gift cards during setup, open the integration’s Settings tab, switch on Giftcards and click Save. Leat then sets gift cards up in your Lightspeed store. Use the Settings tab for this rather than Reconfigure, which runs the setup flow again and doesn’t keep your current settings.