# Lightspeed Retail X-Series (prebuilt connector)

## Description

**Lightspeed Retail X-Series** (formerly Vend) is a retail POS, inventory management, and eCommerce solution.

## API documentation

API documentation for Lightspeed Retail X-Series (used to build this connector) can be found via the link below:

{% embed url="<https://docs.vendhq.com/reference>" %}

## Authentication&#x20;

When adding connector instances for Lightspeed Retail X-Series, the following authentication methods are supported:

* [Token authentication](#token-authentication)

### Token authentication

{% tabs %}
{% tab title="Required credentials" %}
When a user chooses to [add a connector instance](https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/working-with-instances/adding-an-instance) using **token** authentication, the credentials below are prompted:

<table><thead><tr><th width="239">Credential</th><th width="148" data-type="checkbox">Required?</th><th>Note</th></tr></thead><tbody><tr><td>Domain Prefix</td><td>true</td><td>Available from the URL used to access your Lightspeed instance.</td></tr><tr><td>Access Token</td><td>true</td><td>Generated in the Lightspeed console. </td></tr></tbody></table>
{% endtab %}

{% tab title="Obtaining credentials" %}
**Finding your domain prefix**\
\
The **domain prefix** is the first part of the URL that you use to access your Vend instance, immediately before 'vendhq.com' - for example:&#x20;

![](https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FgKifua9ZXF9OCnaTFBpn%2Fls%20eg.png?alt=media\&token=988826a3-7767-4df4-9c15-504dbaab4d74)

**Obtaining an access token**\
\
**Step 1**\
Log into your **Lightspeed/Vend console**.&#x20;

**Step 2**\
Navigate to **setup** > **personal tokens** > **generate personal token**. The **add personal token** page is displayed:

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FiBeKCGlaRAvv6kODTgpk%2Fadd%20personal%20token%20page.png?alt=media&#x26;token=330840e2-87aa-4cba-8fff-06e418f04b8b" alt=""><figcaption></figcaption></figure>

**Step 3**\
In the **name** field, type the following:

```
Patchworks
```

**Step 4**\
If required, set an **expiry** date.

**Step 5**\
Click the **generate personal token** button.&#x20;

**Step 6**\
A token is generated and displayed on screen - add this to your password manager so it's ready for your Patchworks setup when needed.
{% endtab %}
{% endtabs %}