# 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](/product-documentation/connectors-and-instances/working-with-instances/adding-an-instance.md) 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;

![](/files/uOh2oG0XnNyhiX9IRjc1)

**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="/files/GPi7ztnucmj1jiJSzznp" 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 %}


---

# 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://doc.wearepatchworks.com/product-documentation/connectors-and-instances/patchworks-connectors/lightspeed-retail-x-series-prebuilt-connector.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.