Requirements
Connecting Lightspeed Retail takes an active account plus OAuth client credentials, granted by signing in with your account — no other setup is required.[3]
Get your Lightspeed Retail credentials
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
- Client IDtextRequired
The Client ID from your (X-Series) developer app registration.
[1] - Client SecretpasswordRequired
The Client Secret from your (X-Series) developer app registration.
[1]
Integration requests 50 permissions:
audit:readbusiness_rules:readbusiness_rules:writechannels:readconsignments:readconsignments:write:inventory_countconsignments:write:stock_orderconsignments:write:stock_transfercustom_fields:readcustom_fields:writecustomers:readcustomers:writefulfillments:readfulfillments:writegift_cards:readgift_cards:write:issuegift_cards:write:redeeminventory:readinventory:writeoutlets:readpayments:readpayment_types:readproducts:readproducts:read:price_booksproducts:writeproducts:write:price_bookspromotions:readpromotions:writeregister:closeregister:openregisters:readremote_rules:readremote_rules:writeretailer:readsales:readsales:writeserial_numbers:readserial_numbers:writeservices:readservices:writestore_credits:readstore_credits:write:issuestore_credits:write:redeemsuppliers:readsuppliers:writetaxes:readtaxes:writeusers:readusers:writewebhooks
Connect Lightspeed Retail in WEXTL
- Log in to your WEXTL account, add the Lightspeed Retail node module to your workflow, and click Create new credential.Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Lightspeed Retail account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Notes
Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →
Lightspeed Retail node modules
The list below is a reference of every Lightspeed Retail node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Expand any Lightspeed Retail node module below to see exactly what it takes in, what it returns, and what connection it needs.
Watch CustomersTrigger
Output fields[3]
| Field | Type |
|---|---|
| Customer ID | text |
| Retailer ID | text |
| Customer code | text |
| Customer group ID | text |
| First name | text |
| Last name | text |
| Company name | text |
| Do not email | boolean |
24other output fields
Watch ProductsTrigger
Output fields[3]
| Field | Type |
|---|---|
| Product ID | text |
| Retailer ID | text |
| SKU | text |
| Handle | text |
| Name | text |
| Base name | text |
| Description | text |
| Active | boolean |
17other output fields
Watch SalesTrigger
Output fields[3]
| Field | Type |
|---|---|
| Sale ID | text |
| Invoice number | text |
| Short code | text |
| Status | text |
| Source | text |
| Source ID | text |
| Note | text |
| Sale date | date |
13other output fields
Get BrandSearch
Get Button LayoutSearch
Get ConsignmentSearch
Get Consignment TotalsSearch
Get CustomerSearch
Input fields[3]
| Field | Type |
|---|---|
CustomerRequired | choice |
Get Customer AddressSearch
Get Customer GroupSearch
Get Customer Store CreditSearch
Get Customer Store Credit BalanceSearch
Get Fulfillment HistorySearch
Get Fulfillments SummarySearch
Get OutletSearch
Get Price BookSearch
Get ProductSearch
Get Product ImageSearch
Get Product TypeSearch
Get Purchase OrderSearch
Get QuoteSearch
Get RegisterSearch
Get Register Payments SummarySearch
Get Retailer InfoSearch
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Domain Prefix | text |
| Country | text |
| Culture | text |
| Timezone | text |
| Currency | object |
| Code | text |
| Symbol | text |
| Account Status | text |
16other output fields
Get SaleSearch
Get Store Credit ReportSearch
Output fields[3]
| Field | Type |
|---|---|
| Outstanding Balance | number |
| Total Value Issued | number |
| Total Value Redeemed | number |
Get SupplierSearch
Input fields[3]
| Field | Type |
|---|---|
SupplierRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Default Markup | number |
| Source | text |
| Version | number |
| Deleted At | date |
| Contact | object |
| Company Name | text |
| text | |
| Fax | text |
| First Name | text |
| Last Name | text |
| Mobile | text |
| Phone | text |
| Physical Address 1 | text |
| Physical Address 2 | text |
| Physical City | text |
Get TagSearch
Get TaxSearch
Get Variant AttributeSearch
Get WebhookSearch
List BrandsSearch
List Button LayoutsSearch
List Consignment ProductsSearch
List ConsignmentsSearch
List Custom Field DefinitionsSearch
List Custom Field ValuesSearch
List Custom Inventory Adjustment ReasonsSearch
List Customer AddressesSearch
List Customer Group CustomersSearch
List Customer GroupsSearch
List CustomersSearch
List Inventory LevelsSearch
Input fields[3]
| Field | Type |
|---|---|
| Limit | number |
| Outlets | choice |
| Products | choice |
| Root Products | choice |
| Suppliers | choice |
| Group Variants | boolean |
| Include Composites | boolean |
| Include Inactive | boolean |
3other input fields
Output fields[3]
| Field | Type |
|---|---|
| Product ID | text |
| Product Name | text |
| Outlet ID | text |
| Root Product ID | text |
| Brand ID | text |
| Product Type ID | text |
| Supplier ID | text |
| Current Inventory Level | number |
7other output fields
List Inventory Levels For A ProductSearch
List Inventory RecordsSearch
Input fields[3]
| Field | Type |
|---|---|
| Limit | number |
| Product | choice |
| Include Variants | boolean |
| Include Deleted | boolean |
| Sort Direction | choice |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Product ID | text |
| Outlet ID | text |
| Current Inventory Level | number |
| Average Cost | number |
| Quantity To Procure | number |
| Reorder Method | text |
| Reorder Point | number |
4other output fields
List Inventory Records For A ProductSearch
Input fields[3]
| Field | Type |
|---|---|
ProductRequired | choice |
| Limit | number |
| Include Variants | boolean |
| Include Deleted | boolean |
| Order Direction | choice |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Product ID | text |
| Outlet ID | text |
| Current Inventory Level | number |
| Average Cost | number |
| Quantity To Procure | number |
| Reorder Method | text |
| Reorder Point | number |
4other output fields
List Outlet Product TaxesSearch
List OutletsSearch
List Payment TypesSearch
Input fields[3]
| Field | Type |
|---|---|
| Limit | number |
| Outlet | choice |
| Currency | text |
| Include Deleted | boolean |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Name Changed By User | boolean |
| Global Payment Type ID | number |
| Global Payment Type | object |
| ID | number |
| Name | text |
| Category | text |
| Subcategory | text |
| Description | text |
| Internal | boolean |
| Online Only | boolean |
| Disabled | boolean |
| Gateway | boolean |
| Internal | boolean |
6other output fields
List Price Book ProductsSearch
List Price Book Products for a Price BookSearch
List Price BooksSearch
List Price Books for a ProductSearch
List Product CategoriesSearch
List ProductsSearch
List Purchase Order DeliveriesSearch
List Purchase Order Delivery Line ItemsSearch
List Purchase Order Line ItemsSearch
List Purchase OrdersSearch
List QuotesSearch
List RegistersSearch
List SalesSearch
List Stock AdjustmentsSearch
List Store CreditSearch
List SuppliersSearch
Input fields[3]
| Field | Type |
|---|---|
| Limit | number |
| Include Deleted | boolean |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Default Markup | number |
| Source | text |
| Version | number |
| Deleted At | date |
| Contact | object |
| Company Name | text |
| text | |
| Fax | text |
| First Name | text |
| Last Name | text |
| Mobile | text |
| Phone | text |
| Physical Address 1 | text |
| Physical Address 2 | text |
| Physical City | text |
List TagsSearch
List TaxesSearch
List Variant AttributesSearch
List WebhooksSearch
Search ResourcesSearch
Search SalesSearch
Input fields[3]
| Field | Type |
|---|---|
| Limit | number |
| Date From | date |
| Date To | date |
| Time From | text |
| Time To | text |
| Timezone | text |
| State | choice |
| Attributes | array |
| Attribute | choice |
11other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| State | text |
| Short Code | text |
| Invoice Number | text |
| Receipt Number | text |
| Note | text |
| Customer ID | text |
| Sale Date | date |
12other output fields
Add Consignment ProductAction
Add Customers To Customer GroupAction
Add Price Book ProductsAction
Bulk List Store CreditAction
Bulk List Store Credit BalancesAction
Bulk Update Consignment ProductsAction
Close RegisterAction
Create BrandAction
Create ConsignmentAction
Input fields[3]
| Field | Type |
|---|---|
NameRequired | text |
OutletRequired | choice |
TypeRequired | choice |
| Supplier | choice |
| Source Outlet | choice |
| Supplier Invoice | text |
| Due Date | date |
| Consignment Date | date |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Type | text |
| Status | text |
| Outlet ID | text |
| Source Outlet ID | text |
| Supplier ID | text |
| Supplier Invoice | text |
12other output fields
Create Custom Field DefinitionAction
Input fields[3]
| Field | Type |
|---|---|
Entity TypeRequired | choice |
NameRequired | text |
TitleRequired | text |
Value TypeRequired | choice |
| Editable In UI | boolean |
| Visible In UI | boolean |
| Print On Receipt | boolean |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Title | text |
| Entity Type | text |
| Value Type | text |
| Editable In UI | boolean |
| Visible In UI | boolean |
| Created At | date |
Create Custom Inventory Adjustment ReasonAction
Create CustomerAction
Input fields[3]
| Field | Type |
|---|---|
First NameRequired | text |
Last NameRequired | text |
| Company Name | text |
| Customer Code | text |
| Customer Group | choice |
| Phone | text |
| Mobile | text |
29other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| First Name | text |
| Last Name | text |
| Company Name | text |
| Customer Code | text |
| Customer Group ID | text |
| text |
38other output fields
Create Customer AddressAction
Input fields[3]
| Field | Type |
|---|---|
CustomerRequired | choice |
Address Line 1Required | text |
CityRequired | text |
PostcodeRequired | text |
Country CodeRequired | text |
TypeRequired | choice |
| Address Line 2 | text |
| Suburb | text |
2other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Customer ID | text |
| Type | text |
| Address Line 1 | text |
| Address Line 2 | text |
| City | text |
| Suburb | text |
| State | text |
7other output fields
Create Customer GroupAction
Create or Update Product CategoriesAction
Input fields[3]
| Field | Type |
|---|---|
CategoriesRequired | array |
Create Price BookAction
Create ProductAction
Create SaleAction
Input fields[3]
| Field | Type |
|---|---|
StateRequired | choice |
SourceRequired | object |
Author (Cashier)Required | choice |
| Register | choice |
| External Source ID | text |
| External System Type | text |
| Customer | choice |
| Fulfillment Outlet | choice |
| Sale ID | text |
| Sale Date | date |
| Invoice Number | text |
| Short Code | text |
5other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| State | text |
| Short Code | text |
| Invoice Number | text |
| Receipt Number | text |
| Note | text |
| Customer ID | text |
| Sale Date | date |
12other output fields
Create Stock AdjustmentsAction
Create Store Credit HoldAction
Create Store Credit TransactionAction
Create SupplierAction
Create TaxAction
Create Variant AttributeAction
Create WebhookAction
Delete BrandAction
Delete ConsignmentAction
Input fields[3]
| Field | Type |
|---|---|
Consignment IDRequired | text |
Delete Custom Field DefinitionAction
Delete CustomerAction
Input fields[3]
| Field | Type |
|---|---|
CustomerRequired | choice |
Delete Customer AddressAction
Input fields[3]
| Field | Type |
|---|---|
CustomerRequired | choice |
Address IDRequired | number |
Delete Price Book ProductsAction
Input fields[3]
| Field | Type |
|---|---|
Price BookRequired | choice |
Price Book Product IDsRequired | array |
Delete ProductAction
Input fields[3]
| Field | Type |
|---|---|
ProductRequired | choice |
Delete Product CategoriesAction
Delete Product FamilyAction
Input fields[3]
| Field | Type |
|---|---|
Product (in the family)Required | choice |
Delete Product ImageAction
Input fields[3]
| Field | Type |
|---|---|
Product Image IDRequired | text |
Delete SupplierAction
Delete TagAction
Delete Variant AttributeAction
Input fields[3]
| Field | Type |
|---|---|
Variant AttributeRequired | choice |
Delete WebhookAction
Fulfill Line ItemsAction
Fulfill SaleAction
Make an API Calluniversal
Open RegisterAction
Pack Line ItemsAction
Pick Line ItemsAction
Remove Consignment ProductAction
Input fields[3]
| Field | Type |
|---|---|
Consignment IDRequired | text |
ProductRequired | choice |
Remove Customers From Customer GroupAction
Input fields[3]
| Field | Type |
|---|---|
Customer GroupRequired | choice |
| Customers | choice |
Replace Price Book ProductsAction
Return SaleAction
Reverse Store Credit HoldAction
Input fields[3]
| Field | Type |
|---|---|
CustomerRequired | choice |
Reference IDRequired | text |
Set Custom Field ValuesAction
Set Product Image PositionAction
Set Reorder PointsAction
Update BrandAction
Update ConsignmentAction
Input fields[3]
| Field | Type |
|---|---|
Consignment IDRequired | text |
NameRequired | text |
OutletRequired | choice |
TypeRequired | choice |
| Status | choice |
| Supplier | choice |
| Source Outlet | choice |
| Supplier Invoice | text |
1other input field
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Type | text |
| Status | text |
| Outlet ID | text |
| Source Outlet ID | text |
| Supplier ID | text |
| Supplier Invoice | text |
12other output fields
Update Consignment ProductAction
Update Custom Field DefinitionAction
Update Custom Inventory Adjustment ReasonAction
Update CustomerAction
Input fields[3]
| Field | Type |
|---|---|
CustomerRequired | choice |
First NameRequired | text |
Last NameRequired | text |
| Company Name | text |
| Customer Code | text |
| Customer Group | choice |
| Phone | text |
30other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| First Name | text |
| Last Name | text |
| Company Name | text |
| Customer Code | text |
| Customer Group ID | text |
| text |
38other output fields
Update Customer AddressAction
Input fields[3]
| Field | Type |
|---|---|
CustomerRequired | choice |
Address IDRequired | number |
Address Line 1Required | text |
CityRequired | text |
PostcodeRequired | text |
Country CodeRequired | text |
TypeRequired | choice |
| Address Line 2 | text |
3other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Customer ID | text |
| Type | text |
| Address Line 1 | text |
| Address Line 2 | text |
| City | text |
| Suburb | text |
| State | text |
6other output fields
Update Customer GroupAction
Update Price BookAction
Update Price Book ProductsAction
Update ProductAction
Update SaleAction
Input fields[3]
| Field | Type |
|---|---|
Sale to UpdateRequired | choice |
StateRequired | choice |
SourceRequired | object |
Author (Cashier)Required | choice |
| Register | choice |
| External Source ID | text |
| External System Type | text |
| Customer | choice |
| Fulfillment Outlet | choice |
| Sale Date | date |
| Invoice Number | text |
| Short Code | text |
5other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| State | text |
| Short Code | text |
| Invoice Number | text |
| Receipt Number | text |
| Note | text |
| Customer ID | text |
| Sale Date | date |
12other output fields
Update SupplierAction
Update TagAction
Update Variant AttributeAction
Update WebhookAction
Templates
Look for Lightspeed Retail templates in the WEXTL template library.
Browse templates →Explore alternative apps
- Hotmart[2]Manage Hotmart products, subscriptions, sales, payment links, coupons, and members-area content, and react to purchase, subscription, and club events.
- SallaCommerce platform for products, orders, customers, and store operations.
- PatreonMemberships for creators, with campaigns and patrons.
- Amazon Seller PartnerAmazon's API for selling partners to manage orders, listings, inventory, and reports.
- LoyversePoint of sale for retail stores and restaurants, with inventory.
References
- WEXTL® Lightspeed Retail Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Lightspeed Retail.
- WEXTL® visual workflow builder data.
Last updated: Sep 5, 2026 10:05