Lightspeed: merchant plugin guide

This guide describes how to set up a connection between Lightspeed and ChannelEngine.

Table of contents

Introduction

Features

Requirements

Install ChannelEngine on Lightspeed

• On Lightspeed
• On ChannelEngine
• Plugin-specific settings
• Advanced settings
• Activate the integration

How it works

FAQs

Introduction

Lightspeed is a cloud-based commerce platform that helps merchants to manage businesses across multiple channels. It offers tools for setting up online stores, managing inventory, processing orders, and engaging with customers.

To support multichannel selling, ChannelEngine offers a plugin that integrates directly with Lightspeed's ecommerce solution. This integration allows synchronizing your product catalog, inventory, and order data with ChannelEngine. 

Features

Requirements

• Active account on Lightspeed
• Active account and tenant on ChannelEngine

Install Lightspeed plugin on ChannelEngine

On Lightspeed

To establish a connection between Lightspeed and ChannelEngine, request the following credentials from Lightspeed:

• API domain
• API username
• API key

On ChannelEngine

1. Click Plugins from the left-hand side menu.
2. Locate the Lightspeed plugin and click Add.
3. On the plugin Setup page, go to the Connection section. 
4. Enter the credentials you copied into the respective fields.
   

Plugin-specific settings

• Send confirmation emails - enable it to have Lightspeed send notifications, such as order confirmation emails, to the buyer. 
• Mark orders as paid - enable it to mark orders as paid on Lightspeed. 
• Send order invoices - enable it to have Lightspeed email order invoices to buyers.
• Order comment - enter the optional order comment. If provided, ChannelEngine adds your comment to each order.
  • Default comment: Order via ChannelEngine, Besteld op [Marketplace] met bestelnummer [MarketplaceOrderNumber].
  • Enter a variable between square brackets [ ]. E.g.: [Marketplace], [MarketplaceOrderNumber]. ChannelEngine then uses the actual value instead. E.g.: Amazon, 12345.
• Use carrier mapping - enable it to use carrier mapping on ChannelEngine. Otherwise, the shipment title is used as the carrier name. To learn more, check out the FAQs section of this article.
• Payment method for [marketplace] - enter the payment method that is used on that specific marketplace.
• Shipping method for [marketplace] - enter the shipping method that is used on that specific marketplace.

Advanced settings

• Update stock on product import - enable this to update the product's stock whenever the product import is performed.

Activate the integration

To activate the plugin on ChannelEngine, go to the Activation tab and toggle the option Activate synchronization for Lightspeed.

How it works

Once Lightspeed is connected with your ChannelEngine tenant, ChannelEngine imports your product data. It converts products into a format to make them available for use on any marketplace.

When a customer places an order on a marketplace, ChannelEngine retrieves the order and sends it to your webstore. To ship the order, create a shipment in Lightspeed – ChannelEngine then imports the shipment and sends the update to the marketplace.

FAQs

How often does each task run on the Lightspeed plugin?

By default, the Lightspeed plugin follows the schedule below.

Does Lightspeed have a field to indicate the shipment carrier?

No, Lightspeed does not provide a dedicated field for the shipment carrier. It includes only a field for the tracking code.

When ChannelEngine imports a shipment from Lightspeed, the carrier information can come from either:

• A shipment title on the order, or
• A predefined carrier mapping, if you enable the Use carrier mapping setting in the plugin.

If you enable Use carrier mapping, a text box appears where you can define each carrier using the following format: [prefix]:[carrier name]. Add one mapping per line. E.g.:

• 3STQ:PostNL
• 0511:DPD

In this case, if a tracking code starts with '3STQ', ChannelEngine recognizes PostNL as the carrier.

Can I send multiple shipments for a single order on Lightspeed?

No. On Lightspeed, an order can only have one shipment. This means all order lines within a single order must be included in one shipment.

In which currency are orders exported to Lightspeed?

ChannelEngine exports orders in the currency configured in your ChannelEngine tenant. On Lightspeed, you can set a default currency in the admin – this should match the currency set in your tenant for consistency.