Getting Started
1
Create or Select a Project
Set up a new project or select an existing one. See Organizations & Projects.
2
Configure the Connector
Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.
Optionally, configure receiving Events for Lightspeed Retail X-Series into StackOne.
Connector Profile · OAuth 2.0
Requires registering an application in the Lightspeed Developer Portal. Each connection is scoped to one retailer’s stor…
Webhooks setup
3
Link an Account
Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:
Link Account · OAuth 2.0
4
Use Actions
Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.
Actions
|
No scopes found
75 actions
Action
Description
Required scopes
List Brands
Returns a paginated list of brands.
Get A Single Brand
Returns a single brand with a requested ID
Create Brand
Creates a new brand.
List Channels
Returns a list of configured e-commerce channels.
List Consignments
Return a paginated list of consignments.
Get A Single Consignment
Returns a single consignment with the requested ID.
Create A Consignment
Creates a new consignment.
Update A Consignment
Updates the given consignment.
Add A Product To A Consignment
Add a product to a consignment
List All Products For A Specific Consignment
Returns the line items of a consignment.
Update A Product In A Consignment
Updates a line item on a consignment.
List Customers
Returns a paginated list of customers.
Get A Single Customer
Returns a single customer with a requested ID.
Create A New Customer
Creates a new customer.
Update A Customer
Updates the customer with the requested ID.
Delete A Customer
Schedules the customer for deletion.
List Customer Groups
List customer groups
List Gift Cards
Returns a paginated list of gift cards.
Find Gift Card
Finds and returns the given card number. Returns a 404 if the card does not exist.
Create Gift Card
Create a gift card
List Inventory Records
Returns a paginated list of inventory records.
List Stock Adjustments
Returns a paginated list of stock adjustments for the authenticated retailer.
Create Stock Adjustments
Creates one or more stock adjustments in a single batch (1–1000 items per request).
List Custom Inventory Adjustment Reasons
List custom inventory adjustment reasons
Create A Custom Inventory Adjustment Reason
Creates a custom reason that stock adjustments can reference.
List Outlets
Returns a collection of outlets.
Get A Single Outlet
Returns a single outlet with the requested ID.
List Payment Types
Returns a paginated collection of payment types.
List Price Books
Returns a paginated list of price books.
Get A Single Price Book
Returns a single price book with a requested ID
List Price Book Products
Returns a paginated list of price book products.
Create A Single Price Book
Create a single price book
List Products
Returns a paginated list of products.
Get A Single Product
Returns a single product object with a given ID.
Create Product
Creates a new product.
Update A Product
Update an existing product.
Delete A Single Product
Deletes a single product. If a variant ID is provided, that single variant is removed.
List Product Categories
List product categories
Create And Update A Product Category Hierarchy
Create and update a product category hierarchy
Get A Single Product Image Data
Returns the metadata for a single product image with a given ID.
Set Image Position
Allows for changing the image position in the list
Upload An Image
Upload a product image
List Product Types
**DEPRECATED** We recommend using the product_categories endpoint instead.
Get A Single Product Type
Returns a single product type with a given ID.
List Promotions
This endpoint lists all promotions for a retailer.
Get A Promotion By ID
This will retrieve a single promotion using the given ID.
Create A Promotion
This endpoint creates a new promotion.
List Registers
Returns a paginated list of registers.
Get A Single Register
Returns a single register with the requested ID.
Get Information About This Retailer
This endpoint returns information about the retailer.
List Sales
Returns a paginated list of sales.
Get A Single Sale
Returns a single sale with a given ID.
Create A Sale
Create a sale. Returns the ID of the created sale. See Sales 101 for usage information.
Update A Sale
Update an existing sale by ID.
Search For Resources
Search sales, products or customers with filters and sorting
Store Credit List
Returns a list of store credit customers.
List Store Credits For A Given Customer
Returns a list of store credits for the given customer id. Returns HTTP 404 (not 200 + empty array) when the customer ha…
Create A Store Credit Transaction
Create a store credit transaction
Create A Store Credit HOLD Transaction
Places a hold on a customer’s store credit.
List Suppliers
Returns a paginated list of suppliers.
Get A Single Supplier
Returns a single supplier with a given ID.
Create New Supplier
Creates a new supplier.
Update A Supplier
Updates a supplier.
List Tags
Returns a collection of tags.
Get A Single Tag
Returns a single tag with the requested ID.
List Taxes
Returns a paginated list of taxes.
Get A Single Tax
Returns a single tax with a given ID.
Create Tax
Create a tax
List Users
Returns a paginated list of users.
Get A Single User
Returns a single user with the requested ID.
List Variant Attributes
Returns all variant attributes defined for the retailer.
Get A Single Variant Attribute
Returns a single variant attribute with the requested ID.
List Webhooks
List all webhooks.
Create Webhook
Create a webhook.
Delete Webhook
Delete a webhook
Events
|
No tags found
8 events
Event
Description
Tags
Ping
Fallback acknowledgement for unrecognised Lightspeed webhook deliveries. Returns HTTP 200 so the provider does not retry…
Webhooks
Product Updated
Processes Lightspeed product.update webhook events. Fires when product details change (name, description, SKU, price boo…
ProductsWebhooks
Inventory Updated
Processes Lightspeed inventory.update webhook events. Fires when product inventory quantities change through sales, adju…
InventoryWebhooks
Sale Updated
Processes Lightspeed sale.update webhook events. Fires when sales are created or modified. May trigger multiple times fo…
SalesWebhooks
Customer Updated
Processes Lightspeed customer.update webhook events. Fires when customer records are created, modified, or deleted, incl…
CustomersWebhooks
Consignment Sent
Processes Lightspeed consignment.send webhook events. Fires when consigned products are dispatched to their destination…
ConsignmentsWebhooks
Consignment Received
Processes Lightspeed consignment.receive webhook events. Fires when consigned items are received into stock via supplier…
ConsignmentsWebhooks
Register Closure Created
Processes Lightspeed register_closure.create webhook events. Fires each time a register session is closed and reconciled…
RegistersWebhooks