Connect your retail point-of-sale system to automate inventory, sales, and customer data synchronization. When something happens in Lightspeed Retail, sync catalogs, notify ops, or update finance.
Watch CustomersTriggers when Lightspeed sends a customer.update webhook.
Watch ProductsTriggers when Lightspeed sends a product.update webhook.
Watch SalesTriggers when Lightspeed sends a sale.update webhook.
Get BrandReturns a single brand by ID.
Get Button LayoutReturns a single button layout by ID.
Get ConsignmentReturns a single consignment by ID.
Get Consignment TotalsReturns the sent/received cost and count totals for a consignment (not applicable to Stocktake consignments).
Get CustomerReturns a single customer by ID.
Get Customer AddressReturns a single address for a customer.
Get Customer GroupReturns a single customer group by ID.
Get Customer Store CreditRetrieves the store credit balance and transaction history for a single customer.
Get Customer Store Credit BalanceRetrieves the store credit balance for a single customer.
Get Fulfillment HistoryRetrieves the state-change history ledger for a single fulfillment (created, picked, packed, fulfilled, voided, returned events per line item).
Get Fulfillments SummaryRetrieves a paginated list of fulfillment summary items, with optional filtering by outlet, sale, type and state.
Get OutletReturns a single outlet by ID.
Get Price BookReturns a single price book by ID.
Get ProductReturns a single product by ID.
Get Product ImageReturns metadata for a single product image, useful for checking upload status.
Get Product TypeReturns a single product type by ID.
Get Purchase OrderReturns a single purchase order by ID. Cost fields require the products:read:costs scope.
Get QuoteReturns a single quote by ID.
Get RegisterReturns a single register by ID.
Get Register Payments SummaryReturns the payment totals for all payment types on a single register.
Get Retailer InfoReturns information about this retailer.
Get SaleReturns a single sale by ID.
Get Store Credit ReportRetrieves a summary report of store credit issued, redeemed, and outstanding.
Get SupplierReturns a single supplier by ID.
Get TagReturns a single tag by ID.
Get TaxReturns a single tax by ID.
Get Variant AttributeReturns a single variant attribute by ID.
Get WebhookReturns a single webhook by ID.
List BrandsRetrieves a list of brands.
List Button LayoutsRetrieves a list of button layouts.
List Consignment ProductsRetrieves the product line items on a consignment.
List ConsignmentsRetrieves a paginated list of consignments (stock orders, stock transfers, returns, and stocktakes).
List Customer AddressesRetrieves a list of addresses for a customer.
List Customer Group CustomersRetrieves a list of customers in a customer group.
List Customer GroupsRetrieves a list of customer groups.
List CustomersRetrieves a list of customers.
List Custom Field DefinitionsRetrieves the custom field definitions for a given entity type.
List Custom Field ValuesRetrieves the custom field values set on a specific entity.
List Custom Inventory Adjustment ReasonsRetrieves a paginated list of custom inventory adjustment reasons.
List Inventory LevelsRetrieves inventory levels, with optional filters by outlet, product and supplier.
List Inventory Levels For A ProductRetrieves inventory levels for a single product across all outlets.
List Inventory RecordsRetrieves inventory records across all products and outlets.
List Inventory Records For A ProductReturns inventory records for a single product at all outlets.
List Outlet Product TaxesRetrieves a paginated list of outlet-product-tax records.
List OutletsRetrieves a collection of outlets (physical or online stores).
List Payment TypesRetrieves a list of payment types.
List Price Book ProductsRetrieves a list of price book products across all price books.
List Price Book Products for a Price BookRetrieves a list of price book products for a given price book.
List Price BooksRetrieves a list of price books.
List Price Books for a ProductRetrieves the list of price books a given product is in.
List Product CategoriesRetrieves a list of product categories.
List ProductsRetrieves a list of products.
List Product TypesRetrieves a list of product types.
List Purchase Order DeliveriesRetrieves a paginated list of deliveries belonging to a purchase order. Cost fields require the products:read:costs scope.
List Purchase Order Delivery Line ItemsRetrieves a paginated list of line items belonging to a purchase order delivery. Cost fields require the products:read:costs scope.
List Purchase Order Line ItemsRetrieves a paginated list of line items belonging to a purchase order. Cost fields require the products:read:costs scope.
List Purchase OrdersRetrieves a paginated list of purchase orders. Cost fields require the products:read:costs scope.
List QuotesRetrieves a paginated list of quotes.
List RegistersRetrieves a list of registers.
List SalesRetrieves a paginated list of sales.
List Stock AdjustmentsRetrieves a paginated list of stock adjustments.
List Store CreditRetrieves store credit usage for all customers in the store.
List SuppliersRetrieves a paginated list of suppliers.
List TagsRetrieves a list of tags.
List TaxesRetrieves a list of taxes.
List Variant AttributesRetrieves a list of variant attributes.
List WebhooksRetrieves a list of webhooks.
Search ResourcesSearches sales, products, or customers by a flexible set of attributes.
Search SalesSearches sales by date range, state, attributes, customer, register, payment type, product and other filters.
Add Consignment ProductAdds a product line item to a consignment.
Add Customers To Customer GroupAssociates one or more customers with a customer group.
Add Price Book ProductsAdds products to a price book with their price book pricing.
Bulk List Store CreditRetrieves store credit balances and recent transactions for a specific set of customers.
Bulk List Store Credit BalancesRetrieves store credit balances (without transaction history) for a specific set of customers.
Bulk Update Consignment ProductsAdds or updates up to 500 product line items on a consignment in a single request.
Close RegisterCloses a single register with the requested payment totals.
Create BrandCreates a new brand.
Create ConsignmentCreates a new consignment (stock order, stock transfer, return, or stocktake). The legal status transitions differ by type.
Create CustomerCreates a new customer.
Create Customer AddressCreates a new address for a customer.
Create Customer GroupCreates a new customer group.
Create Custom Field DefinitionCreates a new custom field definition for a given entity type.
Create Custom Inventory Adjustment ReasonCreates a new custom inventory adjustment reason.
Create or Update Product CategoriesCreates or updates a product category hierarchy in bulk.
Create Price BookCreates a new price book.
Create ProductCreates a new product.
Create SaleCreates a new sale.
Create Stock AdjustmentsCreates one or more stock adjustments in a single batch.
Create Store Credit HoldCreates a temporary store credit HOLD for a customer; must be reverted or followed by a redemption.
Create Store Credit TransactionIssues, redeems, or reverses store credit for a customer.
Create SupplierCreates a new supplier.
Create TagCreates a new tag.
Create TaxCreates a new tax.
Create Variant AttributeCreates a new variant attribute.
Create WebhookCreates a new webhook subscription.
Delete BrandDeletes a brand and disassociates its products.
Delete ConsignmentPermanently deletes a consignment.
Delete CustomerDeletes a single customer.
Delete Customer AddressDeletes an address for a customer.
Delete Custom Field DefinitionDeletes a custom field and all the values stored on that field.
Delete Price Book ProductsRemoves product entries from a price book.
Delete ProductDeletes a single product or product variant.
Delete Product CategoriesDeletes a list of product categories.
Delete Product FamilyDeletes an entire variant family of products.
Delete Product ImageDeletes a single product image.
Delete SupplierDeletes a supplier. Products associated with the supplier are disassociated, not deleted.
Delete TagDeletes a tag and disassociates its products.
Delete Variant AttributeDeletes a variant attribute.
Delete WebhookDeletes a single webhook.
Fulfill Line ItemsFulfills specific line items within a sale.
Fulfill SaleCompletes all fulfillments for a given sale.
Make an API CallPerforms an arbitrary authorized API call.
Open RegisterOpens a single register with the requested details.
Pack Line ItemsSets pack quantity for line items within a sale.
Pick Line ItemsSets pick quantity for line items within a sale.
Remove Consignment ProductRemoves a product line item from a consignment.
Remove Customers From Customer GroupRemoves one or more customers from a customer group without deleting the customers.
Replace Price Book ProductsFully replaces products already in a price book.
Return SaleInitializes a return for an existing closed sale and returns the newly created return sale.
Reverse Store Credit HoldReverts a previously-created store credit HOLD transaction for a customer.
Set Custom Field ValuesSets one or more custom field values on a given entity.
Set Product Image PositionChanges a product image's position in its product's image list.
Set Reorder PointsSets reorder points for one or more products at specific outlets.
Update BrandUpdates an existing brand.
Update ConsignmentUpdates a consignment, including advancing its status. Legal status transitions are type-specific — see the Status field's help.
Update Consignment ProductUpdates a product line item within a consignment.
Update CustomerUpdates an existing customer.
Update Customer AddressUpdates an existing address for a customer.
Update Customer GroupUpdates an existing customer group.
Update Custom Field DefinitionUpdates properties on an existing custom field definition.
Update Custom Inventory Adjustment ReasonUpdates a custom inventory adjustment reason.
Update Price BookUpdates an existing price book.
Update Price Book ProductsPartially updates products already in a price book.
Update ProductUpdates an existing product.
Update SaleUpdates an existing sale by ID.
Update SupplierUpdates an existing supplier.
Update TagUpdates an existing tag.
Update Variant AttributeUpdates a variant attribute's name.
Update WebhookUpdates an existing webhook.
Upload Product ImageUploads an image file for a product.
When to use Lightspeed Retail
Common scenarios where Lightspeed Retail automation saves time and reduces manual work.
Trigger workflows automatically when "Watch Customers" fires in Lightspeed Retail — start multi-step automations without polling or manual checks.
Automate "Get Button Layout" in Lightspeed Retail as a workflow step — combine it with triggers, filters, and AI steps for full-pipeline coverage.
Combine "Watch Sales" from Lightspeed Retail with triggers or actions in other apps to close the loop — one event, many downstream outcomes.
Frequently asked questions
Common questions about automating Lightspeed Retail in your workflows.
Lightspeed Retail has 3 triggers, including "Watch Customers", "Watch Products", and "Watch Sales". Use them to start workflows the moment Lightspeed Retail events fire — no polling required.
Connect Lightspeed Retail to any app in workflows
Search apps and open an app-to-app integration page in one click.