# Lightspeed Retail X-Series

```json
{
  "name": "Lightspeed Retail X-Series",
  "slug": "lightspeed",
  "url": "https://composio.dev/toolkits/lightspeed",
  "markdown_url": "https://composio.dev/toolkits/lightspeed.md",
  "logo_url": "https://logos.composio.dev/api/lightspeed",
  "categories": [
    "e-commerce"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-08-28T05:38:37.993Z"
}
```

![Lightspeed Retail X-Series logo](https://logos.composio.dev/api/lightspeed)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with Lightspeed Retail X-Series MCP or direct API to read retailer configuration, list products, fetch customers, and retrieve sales across accounts through natural language.

## Summary

Lightspeed Retail X-Series is a point-of-sale and retail management platform.
It centralizes store configuration, inventory, customers, and sales reporting.

## Categories

- e-commerce

## Toolkit Details

- Tools: 7

## Images

- Logo: https://logos.composio.dev/api/lightspeed

## Authentication

- **Oauth2**
  - Type: `oauth2`
  - Description: Oauth2 authentication for Lightspeed Retail X-Series.
  - Setup:
    - Configure Oauth2 credentials for Lightspeed Retail X-Series.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- List low-stock products across all stores
- Summarize today's sales by store
- Find customers with overdue invoices

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `LIGHTSPEED_GET_CUSTOMER` | Get Customer | Retrieve one Lightspeed customer by their exact customer ID. |
| `LIGHTSPEED_GET_PRODUCT` | Get Product | Retrieve one Lightspeed product by its exact product ID. |
| `LIGHTSPEED_GET_RETAILER` | Get Retailer | Return the connected Lightspeed Retail X-Series retailer's identity, account status, configuration, and subscription state. |
| `LIGHTSPEED_LIST_CUSTOMERS` | List Customers | Return one cursor-controlled page of customers from the connected Lightspeed retailer. |
| `LIGHTSPEED_LIST_PAYMENT_TYPES` | List Payment Types | Return one cursor-controlled page of payment types configured for the connected Lightspeed retailer. |
| `LIGHTSPEED_LIST_PRODUCTS` | List Products | Return one cursor-controlled page of products from the connected Lightspeed retailer for catalog discovery. |
| `LIGHTSPEED_LIST_SALES` | List Sales | Return one cursor-controlled page of sales from the connected Lightspeed retailer; an empty page is a successful no-sales result. |

## Supported Triggers

None listed.

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK
```python
pip install composio_openai
```

```typescript
npm install @composio/openai
```

#### Path 1, Step 2: Initialize Composio and Create Tool Router Session

Import and initialize Composio client, then create a Tool Router session
```python
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
openai = OpenAI()
session = composio.create(user_id='your-user-id')
```

```typescript
import OpenAI from 'openai';
import { Composio } from '@composio/core';
import { OpenAIResponsesProvider } from '@composio/openai';

const composio = new Composio({
  provider: new OpenAIResponsesProvider(),
});
const openai = new OpenAI({});
const session = await composio.create('your-user-id');
```

#### Path 1, Step 3: Execute Lightspeed Retail X-Series Tools via Tool Router with Your Agent

Get tools from Tool Router session and execute Lightspeed Retail X-Series actions with your Agent
```python
tools = session.tools
response = openai.responses.create(
  model='gpt-4.1',
  tools=tools,
  input=[{
    'role': 'user',
    'content': 'YOUR_SPECIFIC_PROMPT_HERE'
  }]
)
result = composio.provider.handle_tool_calls(
  response=response,
  user_id='your-user-id'
)
print(result)
```

```typescript
const tools = session.tools;
const response = await openai.responses.create({
  model: 'gpt-4.1',
  tools: tools,
  input: [{
    role: 'user',
    content: 'YOUR_SPECIFIC_PROMPT_HERE'
  }],
});
const result = await composio.provider.handleToolCalls(
  'your-user-id',
  response.output
);
console.log(result);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK for Python or TypeScript
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/openai @ai-sdk/mcp
```

#### Path 2, Step 2: Initialize Client and Create Tool Router Session

Import and initialize the Composio client, then create a Tool Router session for Lightspeed Retail X-Series
```python
from composio import Composio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions

composio = Composio(api_key='your-composio-api-key')
session = composio.create(user_id='your-user-id')
url = session.mcp.url
```

```typescript
import { Composio } from '@composio/core';

const composio = new Composio({ apiKey: 'your-api-key' });
const session = await composio.create('your-user-id');
console.log(`Tool Router session created: ${session.mcp.url}`);
```

#### Path 2, Step 3: Connect to AI Agent

Use the MCP server with your AI agent (Anthropic Claude or Mastra)
```python
import asyncio

options = ClaudeAgentOptions(
    permission_mode='bypassPermissions',
    mcp_servers={
        'tool_router': {
            'type': 'http',
            'url': url,
            'headers': {
                'x-api-key': 'your-composio-api-key'
            }
        }
    },
    system_prompt='You are a helpful assistant with access to Lightspeed Retail X-Series tools.',
    max_turns=10
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query('YOUR_SPECIFIC_PROMPT_HERE')
        async for message in client.receive_response():
            if hasattr(message, 'content'):
                for block in message.content:
                    if hasattr(block, 'text'):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { openai } from '@ai-sdk/openai';
import { experimental_createMCPClient as createMCPClient } from '@ai-sdk/mcp';
import { generateText } from 'ai';

const client = await createMCPClient({
  transport: {
    type: 'http',
    url: session.mcp.url,
    headers: {
      'x-api-key': 'your-composio-api-key',
    },
  },
});

const tools = await client.tools();
const { text } = await generateText({
  model: openai('gpt-4o'),
  tools,
  messages: [{
    role: 'user',
    content: 'YOUR_SPECIFIC_PROMPT_HERE'
  }],
  maxSteps: 5,
});

console.log(`Agent: ${text}`);
```

## Why Use Composio?

### 1. AI Native Lightspeed Retail X-Series Integration

- Supports both Lightspeed Retail X-Series MCP and direct API based integrations
- Structured, LLM-friendly schemas for reliable tool execution
- Rich coverage for reading, writing, and querying your Lightspeed Retail X-Series data

### 2. Managed Auth

- Built-in OAuth handling with automatic token refresh and rotation
- Central place to manage, scope, and revoke Lightspeed Retail X-Series access
- Per user and per environment credentials instead of hard-coded keys

### 3. Agent Optimized Design

- Tools are tuned using real error and success rates to improve reliability over time
- Comprehensive execution logs so you always know what ran, when, and on whose behalf

### 4. Enterprise Grade Security

- Fine-grained RBAC so you control which agents and users can access Lightspeed Retail X-Series
- Scoped, least privilege access to Lightspeed Retail X-Series resources
- Full audit trail of agent actions to support review and compliance

## Use Lightspeed Retail X-Series with any AI Agent Framework

Choose a framework you want to connect Lightspeed Retail X-Series with:

- [ChatGPT Work](https://composio.dev/toolkits/lightspeed/framework/chatgpt)
- [Claude Cowork](https://composio.dev/toolkits/lightspeed/framework/claude-cowork)
- [Hermes](https://composio.dev/toolkits/lightspeed/framework/hermes-agent)

## Related Toolkits

- [Addresszen](https://composio.dev/toolkits/addresszen) - Addresszen is a real-time address autocomplete and verification service. It helps capture accurate, deliverable addresses with instant suggestions and validation.
- [Asin data api](https://composio.dev/toolkits/asin_data_api) - Asin data api gives you detailed, real-time product data from Amazon, including price, rank, and reviews. Perfect for e-commerce pros and data-driven marketers who need instant marketplace insights.
- [Baselinker](https://composio.dev/toolkits/baselinker) - BaseLinker is an all-in-one e-commerce management platform connecting stores, marketplaces, carriers, and more. It streamlines order processing, inventory control, and automates your sales operations.
- [Bestbuy](https://composio.dev/toolkits/bestbuy) - Best Buy is a leading retailer offering APIs for product, store, and recommendation data. Instantly access up-to-date retail insights for smarter shopping and decision-making.
- [Bluebarry](https://composio.dev/toolkits/bluebarry) - Bluebarry is a customer data and product-advice platform for shopper identities, profiles, and recommendations. It helps teams analyze customer context and synchronize shopper data for better commerce experiences.
- [Btcpay server](https://composio.dev/toolkits/btcpay_server) - BTCPay Server is a free, open-source, self-hosted Bitcoin payment processor. It lets merchants accept Bitcoin payments directly, cutting out middlemen and boosting privacy.
- [Cdr platform](https://composio.dev/toolkits/cdr_platform) - Cdr platform is an API for purchasing carbon dioxide removal services. It enables businesses to offset emissions by accessing verified carbon removal projects.
- [Cloudcart](https://composio.dev/toolkits/cloudcart) - CloudCart is an e-commerce platform for building and managing online stores. It helps businesses streamline product listings, orders, and customer engagement.
- [Commerce Layer](https://composio.dev/toolkits/commerce_layer) - Commerce Layer is a headless commerce platform with transactional APIs for orders, inventory, pricing, customers, and fulfillment. Use it to centralize ecommerce operations and surface real-time commerce data.
- [Countdown api](https://composio.dev/toolkits/countdown_api) - Countdown API gives you real-time, structured eBay product data, reviews, and seller feedback. Perfect for powering price monitoring, product research, or marketplace analytics workflows.
- [Dpd2](https://composio.dev/toolkits/dpd2) - Dpd2 is a robust email management platform for handling, sorting, and automating email workflows. Streamline your communications and boost productivity with advanced sorting, labeling, and response tools.
- [Finerworks](https://composio.dev/toolkits/finerworks) - FinerWorks is an online platform for fine art and photo printing services. Artists and photographers use it to order custom prints and manage print inventory efficiently.
- [Fingertip](https://composio.dev/toolkits/fingertip) - Fingertip is a business management platform for selling, booking, and customer engagement—all from a single link. It helps businesses streamline operations and connect with customers across social channels.
- [Fraudlabs pro](https://composio.dev/toolkits/fraudlabs_pro) - FraudLabs Pro is an online payment fraud detection service for e-commerce and merchants. It helps minimize chargebacks and revenue loss by detecting and preventing fraudulent transactions.
- [Gelato](https://composio.dev/toolkits/gelato) - Gelato is a print-on-demand platform for creating products, managing orders, checking stock, and finding shipping options. It helps businesses sell globally with local production, pricing, and fulfillment.
- [Gift up](https://composio.dev/toolkits/gift_up) - Gift Up! is a digital platform for selling, managing, and redeeming gift cards online. It streamlines promotions and gift card transactions for businesses and their customers.
- [Goody](https://composio.dev/toolkits/goody) - Goody is a gifting platform that lets users send gifts and physical products without handling logistics. It streamlines gifting by managing delivery, fulfillment, and recipient experience.
- [Gumroad](https://composio.dev/toolkits/gumroad) - Gumroad is a platform for selling digital products, physical goods, and memberships with a simple checkout and marketing tools. It streamlines creator payouts and helps you grow your audience effortlessly.
- [HitPay](https://composio.dev/toolkits/hitpay) - HitPay is a payments platform offering processing, invoicing, recurring billing, payouts, and merchant business APIs. Helps merchants accept payments and manage cash flow with unified, developer-friendly APIs.
- [Instacart](https://composio.dev/toolkits/instacart) - Instacart is an online grocery delivery and pickup service platform. It lets you discover local retailers and create shoppable lists and recipes with ease.

## Frequently Asked Questions

### Do I need my own developer credentials to use Lightspeed Retail X-Series with Composio?

Yes, Lightspeed Retail X-Series requires you to configure your own OAuth credentials. Once set up, Composio handles token storage, refresh, and lifecycle management for you.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)