Lightspeed Retail Application by Kibo eCommerce

Configuration Guide

Current Version: 1.0.0 (November 2015)
Install: Kibo eCommerce App Marketplace
More Info: Version History

Lightspeed Retail provides services to manage your inventory, point of sale, and reporting through your eCommerce storefront. Customers can browse and purchase products from any storefront on any device using multiple forms of payment (cash, credit, debit, in-store credit, gift cards, and more).

The Lightspeed Retail Application by Kibo eCommerce leverages Lightspeed Retail services to manage your orders, sync your inventory, and extend your management systems. Through the app, you can map Kibo eCommerce locations to Lightspeed shops, set import frequencies for Kibo eCommerce, and manage data imports and exports. You can export data (Products/Categories, Customers, and Discounts) from Kibo eCommerce, modify your inventory configurations in Lightspeed Retail, and import the new data back into Kibo eCommerce to sync orders and inventory amounts.

Note: This app only supports the Lightspeed Retail product.

Application Features:

Lightspeed/Kibo eCommerce Communication Process

When a shopper submits an order and completes payment, the following occurs between Kibo eCommerce and the Lightspeed app:

  1. Lightspeed Retail verifies and processes the order inventory amounts and payment information. If the inventory exists per the entered requests (in-store, online to deliver at home, etc.) and the payment information processes, Lightspeed Retail updates the order status and inventory amounts.
  2. At the configured frequency, the app imports data for completed orders to Kibo eCommerce from Lightspeed Retail.
  3. Kibo eCommerce updates all inventory based on the configured locations, amounts, and purchase/delivery requirements. For example, inventory from a warehouse for online delivery versus in-store pickup from an in-store inventory of a brick and mortar storefront.
  4. As data updates in Kibo eCommerce, any changes, including changes to products and categories, customer entries, are exported back to Lightspeed Retail.

Install the App

You can install the Lightspeed Retail Application by Kibo eCommerce directly from the Kibo eCommerce App Marketplace:

  1. Go to: www.kibocommerce.com/marketplace
  2. In the Search field, enter: Lightspeed
  3. Click the app icon.
  4. On the app page, click Install Now.

Configure the App

To integrate your Lightspeed services with Kibo eCommerce, review the configuration requirements to ensure you have everything you need to be successful before you begin, and then complete the steps in this section.

Configuration Requirements

You must meet the following criteria to configure the Lightspeed Retail Connector app:

Authorize Kibo eCommerce to Access Lightspeed

To integrate your Lightspeed services with Kibo eCommerce, you must authorize Kibo eCommerce to access your Lightspeed account.

Tip: If you have multiple Lightspeed accounts, you can repeat this procedure for each account.

  1. In Admin, go to System > Customization > Applications.
  2. Click Mozu Lightspeed Retail Application.
  3. Click the Configuration link to open configuration settings.
  4. On the Settings tab, click Add Lightspeed Account.
  5. Select a Mozu Site to link to a Lightspeed Retail account and click Next.
  6. Click the Authorize Mozu to Access Lightspeed button.
  7. On the Lightspeed Retail login page, sign in with your Lightspeed credentials to authorize Kibo eCommerce to access your Lightspeed Retail account.
  8. Once you've authorized Kibo eCommerce to use your Lightspeed Retail account, additional fields appear to map your Kibo eCommerce locations to Lightspeed shops:
  9. Select the Lightspeed Account for which you are mapping locations and shops.
  10. Use the Mozu Location and Lightspeed Shop menus to map locations to shops.
  11. (Optional) If you want to map additional Kibo eCommerce locations to Lightspeed shops, click Add Location.
  12. Under Sales Import, select the Import Frequency for data transfers from Lightspeed to Kibo eCommerce. Importing data more frequently ensures the most accurate information appears in Kibo eCommerce. Importing data less frequently can save bandwidth and optimize performance.
    Note: You can also import data manually from the Data Import tab.
  13. Click Save.

Enable the App

After configuration, enable the Lightspeed Retail Application in Kibo eCommerce to apply its functionality to your tenant:

  1. In Admin, go to System > Customization > Applications.
  2. Click Mozu Lightspeed Retail Application.
  3. Click Enable App on the Lightspeed page.

Use the App

Note: You must enable the Lightspeed Retail Application in Kibo eCommerce before you can import or export data.

Export Data From Kibo eCommerce to Lightspeed Retail

You must perform a data export the first time you configure and enable the Lightspeed app. This initial export sets the available products, inventory amounts, and data for orders, including customer records and available discounts. After the initial export, changes to your catalog, customer records, and discounts, are automatically sent to Lightspeed through events.

Note: You do NOT need to manually export data every time you make an update in Kibo eCommerce. After the initial data export, the app automatically handles data additions, deletions, and updates. You only need to re-export data if your data has become inaccurate and you are scrubbing and replacing existing entries.

  1. In Admin, go to System > Customization > Applications.
  2. Click Mozu Lightspeed Retail Application.
  3. Click the Configuration link to open configuration settings.
  4. Go to the Data Export tab.
  5. Select the type of data you want to export to Lightspeed Retail from Kibo eCommerce: Products/Categories, Customers, and/or Discounts. Selecting all options is recommended.
  6. Click Export Now.
  7. An export job begins for each data type, posting an entry in the table with the date/time, number of records exported, status, and a linked error log.

Import Data From Lightspeed Retail to Kibo eCommerce

Most data imports from Lightspeed Retail occur automatically, according to the Import Frequency you specify when you configure the app. The Data Import tab shows the date and time of the Next Scheduled Import, as well as a table listing details for previous imports. Each import contains all sales that were completed since the previous import, and updates order, customer, and inventory data in Kibo eCommerce.

The tab also includes an Import Now option that you can use to manually import data from Lightspeed to Kibo eCommerce:

  1. In Admin, go to System > Customization > Applications.
  2. Click Mozu Lightspeed Retail Application.
  3. Click the Configuration link to open configuration settings.
  4. Go to the Data Import tab.
  5. (Optional) Specify a date range for which to import orders. If you do not specify a date range, the app imports all sales that have been processed in Lightspeed since the last data import.
  6. Click Import Now.
  7. An import job begins from Lightspeed Retail, posting an entry in the table with the date/time, number of sales, status, and a linked error log: