Skip to main content
A Lightspeed Developer Portal account is required. It is separate from your Lightspeed Retail (X-Series) store login.

​
Creating an OAuth application

Register a public application in the Lightspeed Developer Portal to get a Client ID and Client Secret.

1

Sign in to Lightspeed Developer Portal

Sign in to your Lightspeed Developer Portal account.

  • Enter your Email and Password, then click Log in.
  • If you don’t have a developer account yet, click Create account.
The Lightspeed Developer Portal sign-in page with the Email, Password and Log in controls highlighted
2

Add an application

On the My Apps page, open the Applications tab and click Add Application.

The My Apps page with the Add Application button highlighted
3

Enter the application details

Fill in the Basic Details and Redirect URL sections, then click Save.

  • Application Name: StackOne Integration
  • Redirect URL: the Callback URL from your Connector Profile
The Add Application form with the Application Name, Redirect URL and Save controls highlighted
4

Copy the Client ID and Client Secret

After you save, the Copy your Client ID and Secret. dialog shows the new credentials. Click Copy next to each value, then click Done.

  • Client ID — the public identifier of your application. Paste it into the Client ID field in the StackOne Connector profile.
  • Client Secret — the private key StackOne uses to exchange authorization codes for tokens. Paste it into the Client Secret field in the StackOne Connector profile.
  • The Client Secret is only displayed once and cannot be retrieved later. To replace a lost secret, click Edit Application on the application and then Generate New Secret.
  • Store both values securely for use later.
The Copy your Client ID and Secret dialog with both Copy buttons highlighted and the values hidden

​
Choosing scopes

The developer portal has no scope settings on the application. StackOne requests scopes when a store connects, using the Scopes field in the StackOne Connector profile.

1

Set the scopes

Enables actions: Add A Product To A Consignment, Create A Consignment, Create A Custom Inventory Adjustment Reason, Create A New Customer, Create A Promotion, Create A Sale, Create A Single Price Book, Create A Store Credit HOLD Transaction, Create A Store Credit Transaction, Create And Update A Product Category Hierarchy, Create Brand, Create Gift Card, Create New Supplier, Create Product, Create Stock Adjustments, Create Tax, Create Webhook, Delete A Customer, Delete A Single Product, Delete Webhook, Find Gift Card, Get A Promotion By ID, Get A Single Brand, Get A Single Consignment, Get A Single Customer, Get A Single Outlet, Get A Single Price Book, Get A Single Product, Get A Single Product Image Data, Get A Single Product Type, Get A Single Register, Get A Single Sale, Get A Single Supplier, Get A Single Tag, Get A Single Tax, Get A Single User, Get A Single Variant Attribute, Get Information About This Retailer, List All Products For A Specific Consignment, List Brands, List Channels, List Consignments, List Custom Inventory Adjustment Reasons, List Customer Groups, List Customers, List Gift Cards, List Inventory Records, List Outlets, List Payment Types, List Price Book Products, List Price Books, List Product Categories, List Product Types, List Products, List Promotions, List Registers, List Sales, List Stock Adjustments, List Store Credits For A Given Customer, List Suppliers, List Tags, List Taxes, List Users, List Variant Attributes, List Webhooks, Search For Resources, Set Image Position, Store Credit List, Update A Consignment, Update A Customer, Update A Product, Update A Product In A Consignment, Update A Sale, Update A Supplier, Upload An Image

Enter the scopes below in the Scopes field in the StackOne Connector profile, separated by spaces. If you leave the field empty, StackOne requests this full set by default.

​
Creating the StackOne Connector Profile

To create the Connector Profile in StackOne for Lightspeed Retail X-Series:
1

Open the connector

Log in to StackOne, open Connectors, and select Lightspeed Retail X-Series.
2

Choose actions and events

  • Click Add Profile.
  • If the connector offers more than one authentication method, set the Auth Method filter to OAuth 2.0.
  • Select the actions, and any events, to enable for this Connector Profile.
  • Click Continue.
3

Set up authentication

  • Select Authentication Type as OAuth 2.0.
  • Fill out the fields using details retrieved from your provider:
    • Client ID
    • Client Secret
    • Scopes (Optional)
  • Click Create Profile.
Congratulations! The new Connector Profile now shows up on the connector page. If you created it as a project member rather than an admin, it starts disabled until a project admin enables it. You can now continue to Link Accounts for Lightspeed Retail X-Series.