How to get Lightspeed API credentials?

How to get Lightspeed API Key
How to get Lightspeed API Key

To send and receive data from a Lightspeed store, our migration tool needs to access it through the API. The guide below will show you how to retrieve API credentials from three different versions of Lightspeed, including eCom, R-Series, and X-Series (Vend).

Lightspeed eCom

  1. Login to your Lightspeed eCom admin.
  2. Go to Settings > Store Settings > Developers.
  3. Click New API Key.
  4. Enter a name for the API Key then click Save.
  5. In the Settings area, enable the API Key and set all permissions to Read.
  6. Click Save and the API Key and API Secret will display in the Details area.
    Lightspeed API Config

    Lightspeed eCom API

Lightspeed R-Series

  1. Login to your Lightspeed R-Series admin.
  2. Click on this link to add our NC-Migration app to your Lightspeed R-Series account.
  3. Click Authorize Application. You will be prompted to download the file lightspeed_api_key.txt to your computer.
  4. Open the file lightspeed_api_key.txt, you will see the API Key. Please copy it into the migration tool to start the migration.

Lightspeed E-Series

If you are using Lightspeed E-Series (formerly Ecwid), please follow the instructions to obtain its API credentials: How to get API credentials from Ecwid?

Lightspeed X-Series (Vend)

  1. Login to your Vend admin.
  2. Go to Setup > Personal Tokens.
  3. Click Add Personal Token.
  4. Fill in the Token name and uncheck the Expiry date.
  5. Click Generate Personal Token. The Personal Token will be displayed and you can use it for the migration tool.

Lightspeed S-Series

If you are using Lightspeed S-Series, please follow the instructions to export data from it: How to export data from Lightspeed Retail S-Series?

 

*Note: If you cannot find your Lightspeed edition, please don’t hesitate to reach out. We will assist you in obtaining the API information and setting up the migration process based on your requirements.

Related Articles