Help & Resource Center

Lightspeed API Changes


Lightspeed is making some improvements to their application programming interface (API) which will require us to upgrade your integration over the coming months.  New customer who wish to get Lightspeed integrated with their Bigcommerce, Magento, Shopify or WooCommerce website will be affected by this API as well.

Existing Lightspeed Integrations

Existing Modern Retail customers who are already using our Lightspeed integration should be unaffected by this change.  Modern Retail will be upgrading your integration with Lightspeed over the coming months and will be notifying you individually if we anticipate an interruption in service.  Our plan is make this change as seamless as possible for you with little to no downtime if possible.

New Lightspeed Integrations

Our existing Lightspeed integration uses Lightspeed's recently outdated API.  As of October 1, 2016, Lightspeed is no longer giving out API keys.  See Lightspeed's letter below.

This means Modern Retail cannot integrate your Bigcommerce, Magento, Shopify or WooCommerce website until we've upgraded our integration to use Lightspeed's newest API.

Modern Retail will be upgrading to their new API standards later this year.  Once this new integration is completed, we'll be able to connect your Bigcommerce, Magento, Shopify or WooCommerce website to Lightspeed.   As outlined below, Modern Retail must complete this upgrade before the end of the year.

September 2016 Lightspeed Letter

Hello Lightspeed Developers,

As you may be aware, we’ve been working to improve our OAuth2 implementation to bring it up to the full standard. We’ve completed the work on refresh tokens, and as a result we can begin to transition all integrations that use API keys to the more secure OAuth2 authentication method.

You can read about the OAuth2 specification here:

What does this mean for integrators?

API keys will continue to work for some time, however, if your integration does not currently use OAuth, we recommend that you implement it as soon as possible.

You can read more about using OAuth with Lightspeed here:

What is the timeline for API key deprecation?

We will roll out the API key deprecation in phases, described below.

  • Phase 1 - October 1, 2016: We will no longer approve API key requests. Existing API keys will continue to work during this phase.
  • Phase 2 - January 1, 2017: Existing API keys will be deprecated and will no longer be accepted as an authentication method. Customers will need to re-authorize integrations using the OAuth workflow before January 1, 2017.
  • Phase 3 - February 1, 2017: Integrations will be required to support refresh tokens. This will ensure that all integrations are in compliance with Lightspeed’s updated security policies.

As always, if you have any questions regarding OAuth, or concerns with the proposed timeline, please email

Best regards,

API Integrations Support Team