> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Lightspeed Retail X-Series

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

![Lightspeed Retail X-Series logo](https://mintcdn.com/composio-preview/ufpARLIsio16odJB/images/toolkits/lightspeed.svg?fit=max\&auto=format\&n=ufpARLIsio16odJB\&q=85\&s=962672e5c3c67e71c56d20275705f195)

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

## Tools

> [accordion] Get Customer
>
> **Slug:** `LIGHTSPEED_GET_CUSTOMER`
>
> Retrieve one Lightspeed customer by their exact customer ID.
>
> #### Input Parameters
>
> **customer\_id** `string` *required*
>
> Exact customer ID, typically obtained from List Customers.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Product
>
> **Slug:** `LIGHTSPEED_GET_PRODUCT`
>
> Retrieve one Lightspeed product by its exact product ID.
>
> #### Input Parameters
>
> **product\_id** `string` *required*
>
> Exact product ID, typically obtained from List Products.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Retailer
>
> **Slug:** `LIGHTSPEED_GET_RETAILER`
>
> Return the connected Lightspeed Retail X-Series retailer's identity, account status, configuration, and subscription state.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Customers
>
> **Slug:** `LIGHTSPEED_LIST_CUSTOMERS`
>
> Return one cursor-controlled page of customers from the connected Lightspeed retailer.
>
> #### Input Parameters
>
> **cursor** `string`
>
> 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`
>
> Preferred number of customers in this page. Must be positive; the provider's exact maximum is not established.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Payment Types
>
> **Slug:** `LIGHTSPEED_LIST_PAYMENT_TYPES`
>
> Return one cursor-controlled page of payment types configured for the connected Lightspeed retailer.
>
> #### Input Parameters
>
> **cursor** `string`
>
> 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`
>
> Preferred number of payment types in this page. Must be positive; the provider's exact maximum is not established.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Products
>
> **Slug:** `LIGHTSPEED_LIST_PRODUCTS`
>
> Return one cursor-controlled page of products from the connected Lightspeed retailer for catalog discovery.
>
> #### Input Parameters
>
> **cursor** `string`
>
> 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`
>
> Preferred number of products in this page. Must be positive; the provider's exact maximum is not established.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **cursor** `string`
>
> 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`
>
> Preferred number of sales in this page. Must be positive; the provider's exact maximum is not established.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
