---
canonical_url: "https://docs.composio.dev/toolkits/lightspeed"
markdown_url: "https://docs.composio.dev/toolkits/lightspeed.md"
product: "platform"
version: null
last_updated: null
---

# Lightspeed Retail X-Series

Read retailer configuration, products, customers, and sales from Lightspeed Retail X-Series across independently connected retailer accounts.

- **Category:** commerce
- **Auth:** OAUTH2
- **Composio-managed OAuth available?** No
- **Tools:** 7
- **Triggers:** 0
- **Slug:** `LIGHTSPEED`
- **Version:** 00000000_00

## Tools

### Get Customer

**Slug:** `LIGHTSPEED_GET_CUSTOMER`

Retrieve one Lightspeed customer by their exact customer ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | string | Yes | Exact customer ID, typically obtained from List Customers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Product

**Slug:** `LIGHTSPEED_GET_PRODUCT`

Retrieve one Lightspeed product by its exact product ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | string | Yes | Exact product ID, typically obtained from List Products. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Retailer

**Slug:** `LIGHTSPEED_GET_RETAILER`

Return the connected Lightspeed Retail X-Series retailer's identity, account status, configuration, and subscription state.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customers

**Slug:** `LIGHTSPEED_LIST_CUSTOMERS`

Return one cursor-controlled page of customers from the connected Lightspeed retailer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor from a prior response's next_cursor. Omit it for the first page and pass it back unchanged to fetch the next page. |
| `page_size` | integer | No | Preferred number of customers in this page. Must be positive; the provider's exact maximum is not established. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Payment Types

**Slug:** `LIGHTSPEED_LIST_PAYMENT_TYPES`

Return one cursor-controlled page of payment types configured for the connected Lightspeed retailer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor from a prior response's next_cursor. Omit it for the first page and pass it back unchanged to fetch the next page. |
| `page_size` | integer | No | Preferred number of payment types in this page. Must be positive; the provider's exact maximum is not established. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Products

**Slug:** `LIGHTSPEED_LIST_PRODUCTS`

Return one cursor-controlled page of products from the connected Lightspeed retailer for catalog discovery.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor from a prior response's next_cursor. Omit it for the first page and pass it back unchanged to continue after that page. |
| `page_size` | integer | No | Preferred number of products in this page. Must be positive; the provider's exact maximum is not established. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Sales

**Slug:** `LIGHTSPEED_LIST_SALES`

Return one cursor-controlled page of sales from the connected Lightspeed retailer; an empty page is a successful no-sales result.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor from a prior response's next_cursor. Omit it for the first page and pass it back unchanged to fetch the next page. |
| `page_size` | integer | No | Preferred number of sales in this page. Must be positive; the provider's exact maximum is not established. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |