# Lightspeed eCom

This guide is intended for Lightspeed eCom merchants who are connecting their store to Violet. During this process, you will create API credentials in your Lightspeed eCom back office and then provide them to Violet through the Violet Connect onboarding tool. You will retain full control of the created credentials and can revoke them at any time from within your Lightspeed back office. *Total time for completion is around 5 minutes.*

## Step 1: Creating API Credentials

1. Sign in to your Lightspeed eCom back office.
2. Navigate to **Settings › Web extras › API Keys** (or **Apps › API Keys**, depending on your back office version).
3. Click **Add API Key**.
4. Enter a description for the key (e.g. `Violet integration`) so it is easy to identify later.
5. Once created, you will be shown an **API Key** and an **API Secret**. Copy both values — you will paste them into Violet in **Step 3**.

{% hint style="warning" %}
The API Secret is only shown once at creation time. If you lose it, you will need to delete the key and create a new one.
{% endhint %}

## Step 2: Locating Your Store URL

1. Your Lightspeed eCom API base URL is typically in the format `https://api.shoplightspeed.com/en/` or your custom storefront domain.
2. You can confirm the URL by checking the address bar in your Lightspeed back office, or by navigating to **Settings › General › Domains** to see your configured domains.
3. Have this URL ready — you will paste it into Violet in **Step 3**. Violet will normalize the value, so trailing slashes or mixed casing are fine.

## Step 3: Provide Credentials to Violet

1. In the Violet Connect onboarding tool, select **Lightspeed** as your platform.
2. Enter your **Store URL** from Step 2 and click **Next**.
3. Paste the **API Key** from Step 1 into the **API Key** field.
4. Paste the **API Secret** from Step 1 into the **API Secret** field.
5. Submit the form. Violet will immediately validate the credentials by calling the Lightspeed Account endpoint. If the credentials are valid, you will be redirected to the next step of onboarding; if they are rejected, you will see an error message and can retry with corrected values.

Upon success you will be redirected back to the channel who first sent you to Violet.

## Credential Summary

| Credential | Required | Where to find it                                 | Example                              |
| ---------- | -------- | ------------------------------------------------ | ------------------------------------ |
| API Key    | Yes      | Lightspeed back office › **Settings › API Keys** | `abc123def456...`                    |
| API Secret | Yes      | Shown once at API key creation time              | `xyz789ghi012...`                    |
| Store URL  | Yes      | Lightspeed back office › **Settings › Domains**  | `https://api.shoplightspeed.com/en/` |

## Special Considerations

### Credential Security

Lightspeed API credentials grant access to your store data including products, orders, and customers. Treat them like passwords:

* Never share them outside of the secure Violet onboarding form.
* Do not embed them in client-side code, screenshots, or support tickets.
* If you suspect the credentials have been compromised, revoke them immediately (see below) and generate new ones.

### Credential Expiration

Lightspeed eCom API keys **do not expire**. There is no need to schedule periodic rotation, but you can rotate credentials at any time by creating a new key pair in Lightspeed, providing it to Violet, and then deleting the old one.

### Revoking Credentials

To revoke your API credentials at any time:

1. Sign in to your Lightspeed eCom back office.
2. Navigate to **Settings › Web extras › API Keys**.
3. Locate the row for your Violet integration key.
4. Delete the key.

Once revoked, all subsequent Violet API calls to your store will fail with an authorization error. Generate and provide new credentials to restore the integration.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://merchant-help.violet.io/platform-guides/lightspeed.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.