> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Lightspeed Retail X-Series

> How to set up the Lightspeed Retail X-Series connector, plus the actions and events that are available.

![Lightspeed Retail X-Series](https://stackone-logos.com/api/lightspeed/filled/svg)

Previewv2.0.0[See changelog](https://docs.stackone.com/connectors/lightspeed/changelog.md)

[75 actions](#actions) · [8 events](#events) · 1 auth method

E-Commerce

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/lightspeed/guides/connector-profile/oauth-2-0.md)
>
> Requires registering an application in the Lightspeed Developer Portal. Each connection is scoped to one retailer's stor...

Optionally, configure receiving Events for Lightspeed Retail X-Series into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/lightspeed/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/lightspeed/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

channels:read

consignments:read

consignments:write:inventory\_count

consignments:write:stock\_order

consignments:write:stock\_transfer

customers:read

customers:write

gift\_cards:read

gift\_cards:write:issue

inventory:read

inventory:write

outlets:read

payment\_types:read

products:read

products:read:price\_books

products:write

products:write:price\_books

promotions:read

promotions:write

registers:read

retailer:read

sales:read

sales:write

store\_credits:read

store\_credits:write:issue

store\_credits:write:redeem

suppliers:read

suppliers:write

taxes:read

taxes:write

users:read

webhooks

No scopes found

75 actions

ActionDescriptionRequired scopes

List Brands`lightspeed_list_brands`

Returns a paginated list of brands.

`products:read`

Get A Single Brand`lightspeed_get_brand`

Returns a single brand with a requested ID

`products:read`

Create Brand`lightspeed_create_brand`

Creates a new brand.

`products:write`

List Channels`lightspeed_list_channels`

Returns a list of configured e-commerce channels.

`channels:read`

List Consignments`lightspeed_list_consignments`

Return a paginated list of consignments.

`consignments:read`

Get A Single Consignment`lightspeed_get_consignment`

Returns a single consignment with the requested ID.

`consignments:read`

Create A Consignment`lightspeed_create_consignment`

Creates a new consignment.

`consignments:write:inventory_count``consignments:write:stock_order``consignments:write:stock_transfer`

Update A Consignment`lightspeed_update_consignment`

Updates the given consignment.

`consignments:write:inventory_count``consignments:write:stock_order``consignments:write:stock_transfer`

Add A Product To A Consignment`lightspeed_create_consignment_product`

Add a product to a consignment

`consignments:write:stock_order`

List All Products For A Specific Consignment`lightspeed_list_consignment_products`

Returns the line items of a consignment.

`consignments:read`

Update A Product In A Consignment`lightspeed_update_consignment_product`

Updates a line item on a consignment.

`consignments:write:stock_order`

List Customers`lightspeed_list_customers`

Returns a paginated list of customers.

`customers:read`

Get A Single Customer`lightspeed_get_customer`

Returns a single customer with a requested ID.

`customers:read`

Create A New Customer`lightspeed_create_customer`

Creates a new customer.

`customers:write`

Update A Customer`lightspeed_update_customer`

Updates the customer with the requested ID.

`customers:write`

Delete A Customer`lightspeed_delete_customer`

Schedules the customer for deletion.

`customers:write`

List Customer Groups`lightspeed_list_customer_groups`

List customer groups

`customers:read`

List Gift Cards`lightspeed_list_gift_cards`

Returns a paginated list of gift cards.

`gift_cards:read`

Find Gift Card`lightspeed_get_gift_card`

Finds and returns the given card number. Returns a 404 if the card does not exist.

`gift_cards:read`

Create Gift Card`lightspeed_create_gift_card`

Create a gift card

`gift_cards:write:issue`

List Inventory Records`lightspeed_list_inventory`

Returns a paginated list of inventory records.

`inventory:read`

List Stock Adjustments`lightspeed_list_stock_adjustments`

Returns a paginated list of stock adjustments for the authenticated retailer.

`inventory:write`

Create Stock Adjustments`lightspeed_create_stock_adjustment`

Creates one or more stock adjustments in a single batch (1–1000 items per request).

`inventory:write`

List Custom Inventory Adjustment Reasons`lightspeed_list_custom_inventory_adjustment_reasons`

List custom inventory adjustment reasons

`inventory:write`

Create A Custom Inventory Adjustment Reason`lightspeed_create_custom_inventory_adjustment_reason`

Creates a custom reason that stock adjustments can reference.

`inventory:write`

List Outlets`lightspeed_list_outlets`

Returns a collection of outlets.

`outlets:read`

Get A Single Outlet`lightspeed_get_outlet`

Returns a single outlet with the requested ID.

`outlets:read`

List Payment Types`lightspeed_list_payment_types`

Returns a paginated collection of payment types.

`payment_types:read`

List Price Books`lightspeed_list_price_books`

Returns a paginated list of price books.

`customers:read``outlets:read``products:read:price_books`

Get A Single Price Book`lightspeed_get_price_book`

Returns a single price book with a requested ID

`customers:read``outlets:read``products:read:price_books`

List Price Book Products`lightspeed_list_price_book_products`

Returns a paginated list of price book products.

`products:read:price_books`

Create A Single Price Book`lightspeed_create_price_book`

Create a single price book

`products:write:price_books`

List Products`lightspeed_list_products`

Returns a paginated list of products.

`products:read`

Get A Single Product`lightspeed_get_product`

Returns a single product object with a given ID.

`products:read`

Create Product`lightspeed_create_product`

Creates a new product.

`products:write`

Update A Product`lightspeed_update_product`

Update an existing product.

`products:write`

Delete A Single Product`lightspeed_delete_product`

Deletes a single product. If a variant ID is provided, that single variant is removed.

`products:write`

List Product Categories`lightspeed_list_product_categories`

List product categories

`products:read`

Create And Update A Product Category Hierarchy`lightspeed_bulk_product_category`

Create and update a product category hierarchy

`products:write`

Get A Single Product Image Data`lightspeed_get_product_image`

Returns the metadata for a single product image with a given ID.

`products:read`

Set Image Position`lightspeed_update_product_image`

Allows for changing the image position in the list

`products:write`

Upload An Image`lightspeed_upload_image`

Upload a product image

`products:write`

List Product Types`lightspeed_list_product_types`

\*\*DEPRECATED\*\* We recommend using the product\_categories endpoint instead.

`products:read`

Get A Single Product Type`lightspeed_get_product_type`

Returns a single product type with a given ID.

`products:read`

List Promotions`lightspeed_list_promotions`

This endpoint lists all promotions for a retailer.

`promotions:read`

Get A Promotion By ID`lightspeed_get_promotion`

This will retrieve a single promotion using the given ID.

`promotions:read`

Create A Promotion`lightspeed_create_promotion`

This endpoint creates a new promotion.

`promotions:write`

List Registers`lightspeed_list_registers`

Returns a paginated list of registers.

`registers:read`

Get A Single Register`lightspeed_get_register`

Returns a single register with the requested ID.

`registers:read`

Get Information About This Retailer`lightspeed_get_retailer`

This endpoint returns information about the retailer.

`payment_types:read``retailer:read`

List Sales`lightspeed_list_sales`

Returns a paginated list of sales.

`sales:read`

Get A Single Sale`lightspeed_get_sale`

Returns a single sale with a given ID.

`sales:read`

Create A Sale`lightspeed_create_sale`

Create a sale. Returns the ID of the created sale. See [Sales 101](https://docs.stackone.com/docs/sales_101.md) for usage information.

`sales:write`

Update A Sale`lightspeed_update_sale`

Update an existing sale by ID.

`sales:write`

Search For Resources`lightspeed_search`

Search sales, products or customers with filters and sorting

`sales:read`

Store Credit List`lightspeed_list_store_credits`

Returns a list of store credit customers.

`store_credits:read`

List Store Credits For A Given Customer`lightspeed_get_store_credit`

Returns a list of store credits for the given customer id. Returns HTTP 404 (not 200 + empty array) when the customer ha...

`store_credits:read`

Create A Store Credit Transaction`lightspeed_create_store_credit_transaction`

Create a store credit transaction

`store_credits:write:issue``store_credits:write:redeem`

Create A Store Credit HOLD Transaction`lightspeed_create_store_credit_hold`

Places a hold on a customer's store credit.

`store_credits:write:redeem`

List Suppliers`lightspeed_list_suppliers`

Returns a paginated list of suppliers.

`suppliers:read`

Get A Single Supplier`lightspeed_get_supplier`

Returns a single supplier with a given ID.

`suppliers:read`

Create New Supplier`lightspeed_create_supplier`

Creates a new supplier.

`suppliers:write`

Update A Supplier`lightspeed_update_supplier`

Updates a supplier.

`suppliers:write`

List Tags`lightspeed_list_tags`

Returns a collection of tags.

`products:read`

Get A Single Tag`lightspeed_get_tag`

Returns a single tag with the requested ID.

`products:read`

List Taxes`lightspeed_list_taxes`

Returns a paginated list of taxes.

`taxes:read`

Get A Single Tax`lightspeed_get_tax`

Returns a single tax with a given ID.

`taxes:read`

Create Tax`lightspeed_create_tax`

Create a tax

`taxes:write`

List Users`lightspeed_list_users`

Returns a paginated list of users.

`users:read`

Get A Single User`lightspeed_get_user`

Returns a single user with the requested ID.

`users:read`

List Variant Attributes`lightspeed_list_variant_attributes`

Returns all variant attributes defined for the retailer.

`products:read`

Get A Single Variant Attribute`lightspeed_get_variant_attribute`

Returns a single variant attribute with the requested ID.

`products:read`

List Webhooks`lightspeed_list_webhooks`

List all webhooks.

`webhooks`

Create Webhook`lightspeed_create_webhook`

Create a webhook.

`webhooks`

Delete Webhook`lightspeed_delete_webhook`

Delete a webhook

`webhooks`

## Events

Tags

Select all
|
Clear

Consignments

Customers

Inventory

Products

Registers

Sales

Webhooks

No tags found

8 events

EventDescriptionTags

Ping`lightspeed_webhook_ping`

Fallback acknowledgement for unrecognised Lightspeed webhook deliveries. Returns HTTP 200 so the provider does not retry...

Webhooks

Product Updated`lightspeed_webhook_product_update`

Processes Lightspeed product.update webhook events. Fires when product details change (name, description, SKU, price boo...

ProductsWebhooks

Inventory Updated`lightspeed_webhook_inventory_update`

Processes Lightspeed inventory.update webhook events. Fires when product inventory quantities change through sales, adju...

InventoryWebhooks

Sale Updated`lightspeed_webhook_sale_update`

Processes Lightspeed sale.update webhook events. Fires when sales are created or modified. May trigger multiple times fo...

SalesWebhooks

Customer Updated`lightspeed_webhook_customer_update`

Processes Lightspeed customer.update webhook events. Fires when customer records are created, modified, or deleted, incl...

CustomersWebhooks

Consignment Sent`lightspeed_webhook_consignment_send`

Processes Lightspeed consignment.send webhook events. Fires when consigned products are dispatched to their destination...

ConsignmentsWebhooks

Consignment Received`lightspeed_webhook_consignment_receive`

Processes Lightspeed consignment.receive webhook events. Fires when consigned items are received into stock via supplier...

ConsignmentsWebhooks

Register Closure Created`lightspeed_webhook_register_closure_create`

Processes Lightspeed register\_closure.create webhook events. Fires each time a register session is closed and reconciled...

RegistersWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.