Out of the box, the integration offers an Omni-channel environment. With all Management centralized in the Retail Point of Sales system. After syncing is initialized, catalog data is imported to Magento and completed orders are exported back to Lightspeed keeping the inventory up-to-date and stock latency to a minimum.

Smart HASH Logic was implemented to sync only changes detected from Lightspeed. I.E. A product description change occurs in Lightspeed, there’s a hash code mismatch with the Magento version, hence that SKU is flagged to be part of the next sync.

Lightspeed API bucket size range from 30/90, our module conforms to the Bucket’s range.

Definition

Lightspeed Retail

Product carried by the Lightspeed HQ company. It is a cloud-based POS system, with everything you need to manage your in-store inventory effectively and intuitively.

Magento 2 eCommerce

Amazing expandability and robustness for businesses looking for a solid platform to sell online. Magento eCommerce offers great capability to integrate with 3rd party services.

Lightspeed + Magento 2 connector

Simply a bridge connector developed to marry both platforms and make them work seamlessly hands in hands.

The connector offers robust and intelligent capabilities to handle different limitations and integrate with ease with different store environments.

This documentation will illustrate the Syncing Operations Logic environment and core features embedded into the module. If you have any specific questions or concerns, kindly drop us a line from the Support section at the bottom of this document.

Syncing Operations Logic

Environment

This module will not work with existing product’s catalog in Magento.

Upon initial setup of the module, new attribute set “Lightspeed” will be created. Under which all Lightspeed products will sync to. It is not possible to alter this logic, since with the new attribute set comes new dependencies required for future syncing.

If you have an existing product catalog in Magento, it is possible to migrate your product’s data to the new products belonging to “Lightspeed”. This data migration is not covered by the module, you may wish to use the Export / Import feature built-in Magento in order to migrate your attributes and data to the new attribute set. Be aware that “synced fields” discussed below, are updated upon each sync.

Images

Simple product images are imported from Lightspeed and create a gallery whereas applicable.

Configurable product’s images are taken from their simple products children.

You can add images manually in Magento, they will not be overwritten.

Smart Hash

Smart hash implemented. To detect products changes on Lightspeed and sync them back in Magento.

Multi-store setup

The whole inventory from your Lightspeed account is used in Magento. (Not inventory per location)

You can specify the Lightspeed store location to automatically deduct the inventory from. You can also edit this information when processing the order in Lightspeed itself.

It is NOT possible to use separate inventory per store view in Magento. We investigated this feature, as Magento doesn’t support multiple inventory and the self-hosted module complies 100% with Magento, it is a limitation out of our reach.

Module core features

Catalog syncing

Simple Products

Name
SKU
Descriptions
Price
Tax Class
Images

Additional images support on Magento side
Multiple images from LS mapped as gallery

Inventory

Stock levels
Products changes (Hash used for version comparison)
Inventory status
Backorder support

Configurable Products (known as Matrix in LS)

Unlimited attributes combinationsupported (color, size, width and any custom ones)
Association with related Simple Products
Configurable products SKU in Magento: prefix CONF-LS-

Categories

Subcategories

Sub-Subcategories

Tags

Filter by Tags

Select one or multiple Tags. Lightspeed products matching those tags will sync.

Orders syncing

“Completed” orders status instantly pushed to LS
Order sync status in Grid

RED: Synced (with direct link to attached order in Lightspeed)
GRAY: Pending sync (clickable to manually Sync it if needed)
YELLOW: Not syncable

Syncing methods

Manual syncing buttons (for testing purposes - watch for php timeouts under larger catalogs)

Product’ sync button on Catalog > Products
Sync button in System > Config

Import product’ sync
Initial import sync

CRON job (recommended for production usage - recurrent server sync)

Retry “Pending sync” orders
Transmit orders
Sync catalog products with unmatched hashes

Manufacturers

LS manufacturers populated as attribute lsmanufacturers in Magento

Payment Methods

Maps to“Card Payment” in LS

Configuration

Map specific LS store to specific Magento store

Lightspeed store ID (if multiple shop location enabled in LS, default is 1)
Magento website/store ID (Magento store view to map with)

The register ID to work with

Lightspeed register ID (if multiple shop location is enabled in LS, default is 1.)

Employee ID

Lightspeed employee ID (API key requester)

Skips orders before

Date to sync orders from

Shipping mapping

If unspecified

“cost” field in LS is used for shipping costs

Specified non-inventory item

Define the item ID to include as Sales Item

API features for Developers

Extensive logs stored in db, 30-days accessible from admin

Throw error with full details

Module conforms to LS API Leaky Bucket implementation

Synced fields from Lightspeed.
Those attributes are created in your Magento

'name' =>

'short_description' =>

'description' =>

'width' =>

'height' =>

'length' =>

'weight' =>

'price' =>

‘Msrp’ =>

'categories' =>

'images' =>

'additional_attributes' =>

'last_updated' =>

'lsmanufacturers' =>

Standard Magento installation

Step 1.

If you’ve ordered from Maurisource store directly, if purchased from Magento marketplace skip to Step.2
Retrieve your welcome email from Sendowl “My downloadable products”

Step 2.

Local install: Extract package and Merge the “app/” folder into your Magento root folder.

Marketplace install via SSH command line:
$composer require maurisource/lightspeed
Insert Magento Marketplace public key as username and private key as password.

Step 3. Full list of cli commands and subcommands from official Magento DevDocs

Issue basic command: (Warning! If you don’t know what you’re doing, please refer to your host or web developer as this can have some serious consequence on your store. You can also purchase installation services)

Log in your SSH command line tool, with the Magento 2 sudo user.
Input the following command to complete install:
$ php bin/magento setup:upgrade
Compile, flush Magento Cache and Reindex
$ php bin/magento cache:flush
$ php bin/magento i:rei

For detailed installation instructions visit the HelpCenter Installation guide

0Auth authorization

Your License Key will be generated and provided to you 24 hours after processing your order.

Please follow the guidelines illustrated on the the Help Center to connect the module to your Lightspeed Retail account.

Up-to-date instructions can be found here:

https://maurisource.zendesk.com/hc/en-us/categories/202582267-LIGHTSPEED

Lightspeed Configuration Settings

The screenshot illustrates Magento 1 interface. But it’s the same fields in M2

HIGH RESOLUTION image here.

Employee ID. Find your Employee ID. Select the same admin Employee that authorized access to the Integration i.e. "Magento Store" (That way in reports you'll know exactly where the sales are coming from)

Go to Setting > Employee Setup
Hover your mouse over an Employee and you'll see a suffix at the end of the URL
form_name=view&name=admin.views.employee&id=1

Screen Shot 2016-07-04 at 5.24.43 PM.png

Shop ID. If you have only 1 shop, use “1”.
(Optional: for multiple-shop location setup in Lightspeed, If you want your inventory to match a specific store location, then you can change it here.)

Find the Shop ID under Settings > Shop as shown on screenshot below

Screen Shot 2016-07-04 at 5.30.13 PM.png

F - Register ID. By default it’s 1. Optional: If you have multi-shop locations setup, then you have different Register ID. (This sets to which Register your want your Magento orders to sync with.)

Find your Register ID under the actual shop. (watch the recording below)

G - Sync to website. To which Magento website you want your products and orders to sync with? It can be all of them, or a specific one.

H - Shipping Item ID. (Optional). You can create a non-inventory product in LS to append your shipping cost to it and have better understanding on your Reports. I.E. “CUSTOMER SHIPPING”

If you don’t specify anything, Shipping will be mapped as “cost” by default in your Totals in LS.

If you do specify the Shipping Item ID, Shipping will still be mapped as “cost” by default in your Totals + the non-inventory Item ID will be included under your Sale Lines as below.

Screen Shot 2016-07-04 at 5.51.24 PM.png

I - Cloud Lightspeed domain to use. This is attributed to you once you’ve created a Lightspeed Retail account based on your location.

To find it: Once you logged in Lightspeed Retail, this is the domain you see in your web browser: I.E https://us.merchantos.com/

Only input this under settings: us.merchantos.com

J - Order date. If you want to set a timestamp for orders syncing in order to ignore orders before a certain date, this is where you do it.

K - Sync now. Trigger an initial sync (up to 500 products) ideal to test if things are working. It’s limited to 500 recent products to avoid possible timeouts. This is not a replacement to using Magento’s default CRON.

The manual sync button can also be seen under Catalog > Manage products (Top-Right section) there will be a button named “Import from Lightspeed)

Matrix / Configurable products

Also known as Matrix in Lightspeed and as Configurable Products in Magento. They are the same thing.

The module will sync unlimited dynamic attributes as Configurable product types in Magento.

No SKUs are existent in Lightspeed for Matrix elements, only IDs. So in Lightspeed we attached the SKU prefix CONF-LS- following the Lightspeed ID.

I.E CONF-LS-5 (relates to the ID element 5 in Lightspeed)

Support & Terms

Maurisource provides free updates to this module branch 2.x.x, based on recommendations and bugs reported by our trusted customers. Newly release versions will be deployed frequently and can be found under “my account” . Following same installation guidelines. (Don’t worry, your settings won’t be overridden when upgrading.)

We provide 1 free installation support per license domain. If you need more installations on other domains, you will need to place new orders respectively.

Support channels related to the integraiton:

lightspeed@maurisource.zendesk.com

https://maurisource.com/store/support/

Helpcenter related to the integration:

https://maurisource.zendesk.com/hc/en-us/categories/202582267-LIGHTSPEED

IMPORTANT: Usage of this module is limited to 1 license per domain as agreed by our Terms of use. If you need multiple license to use with other domains please place your order again and have proper support for your products. Breaching our softwares will result in immediate account termination and in some cases appropriate legal actions.

Thank you, looking forward to your business.

https://maurisource.com

Documentation last updated: 2020-06-30 based on package v.1.3.2

Welcome to Lightspeed Retail (R-Series) POS + Magento 2

v1.4.X - Documentation

Ticketing support channel: lightspeed@maurisource.zendesk.com

Table of Contents

Overview