Hub onboarding guide

Lightspeed Retail R-Series

Integration details

How Trail Hits Hub connects to Lightspeed, the data it uses, and the settings that control changes sent back to your POS.

Authorization and permissions

A shop owner or administrator connects Hub using Lightspeed OAuth. The shop reviews and approves the access request in Lightspeed. Use a dedicated Lightspeed staff account for the connection, as described in the setup guide.

The permissions granted through OAuth and Hub’s sync mode are separate controls. Read-only mode prevents Hub’s supported integration actions from writing back; it does not change the OAuth permissions previously granted. Review the Lightspeed authorization screen for the permissions requested by the app.

Data flow and sync modes

Lightspeed to Hub

Customers, employee information, work orders, statuses, customer items, labor and parts catalog details, and sales information support Hub’s service workflows, history and reports.

Hub to Lightspeed

With read and write enabled, supported actions can create or update customers, work orders, mapped statuses, notes, labor and parts. Some features, such as employee-hours sync, also require their own configuration.

Inventory and sales are part of the integration. Hub reads item pricing and stock availability, adds approved parts to Lightspeed work orders and sale lines, and can create sales through supported estimate and invoice workflows. These sales can affect inventory and reporting in Lightspeed. Reading the item catalog uses GET requests; writing parts to a work order or sale uses those records’ endpoints.

Read-only is the default during onboarding. Before enabling read and write, review status and labor mappings and the outgoing location, register, employee and tax defaults. Customer edits and other configured sync actions may write back automatically; outgoing changes are not limited to the estimate button.

Disconnect the integration in Hub’s Integrations settings to stop future syncing. Previously synced records are not automatically deleted by disconnecting. See the Trail Hits privacy policy for data handling.

API endpoints and methods

R-Series account resources use the base path /API/V3/Account/{accountID}/. The table groups collection and individual-record paths by resource. Methods apply to the relevant path within each group. Calls depend on the workflow and enabled settings; a shop does not use every endpoint on every sync.

On a small screen, scroll the table sideways to see all columns.

Lightspeed R-Series endpoints used by Hub integration workflows
Resource pathsMethodsPurpose
Customer.json; Customer/{id}.jsonGET, POST, PUTRead customers; create or update customers through supported Hub actions.
Workorder.json; Workorder/{id}.jsonGET, POST, PUTRead and create work orders; update supported details, mapped statuses and notes.
Workorder/{id}/WorkorderLine.json; Workorder/{id}/WorkorderLine/{lineId}.jsonGET, POST, PUTRead, add and update labor lines.
Workorder/{id}/WorkorderItem.json; Workorder/{id}/WorkorderItem/{itemId}.jsonGET, POST, PUTRead, add and update work-order items.
WorkorderStatus.jsonGETRead the shop’s work-order statuses for mapping.
Item.json; Item/{id}.jsonGETRead the parts and labor catalog, item pricing and stock availability.
Category.jsonGETRead labor and parts categories.
Sale.json; Sale/{id}.jsonGET, POSTRead sales for service history and reporting; create sales in supported estimate or invoice flows.
Sale/{id}/SaleLine.jsonGET, POSTRead sale lines and add lines in supported estimate flows.
SaleLine/{id}.jsonGETRead individual sale lines and related work-order information.
Sale/{id}/SaleNote.jsonPOSTAdd estimate or inspection notes to a linked sale.
Serialized.jsonGET, POSTRead customer items and create linked bike records through supported actions.
Employee.jsonGETRead employees for technician mapping and attribution.
EmployeeHours.jsonPOSTSend eligible time blocks when employee-hours sync is enabled and configured.
Shop.json; Register.jsonGETResolve the outgoing location and its register.
Vendor.json; TaxClass.jsonGETRead catalog metadata and tax configuration.
Reports/Accounting/PaymentsByDay.jsonGETRetrieve accounting report data when requested.

Related records such as contacts and notes may be loaded as relations on another resource rather than through a separate endpoint. During connection setup, Hub also reads GET /API/V3/Account.json to identify the authorized account. Token exchange uses POST https://cloud.lightspeedapp.com/auth/oauth/token. These calls are separate from the account-resource paths above.

Sync frequency

  • Work orders: incremental sync every 5 minutes during each shop’s local business-hours window, 6am to 10pm. The scheduled work-order poll does not run overnight.
  • Focus refresh: up to 50 current work orders, refreshed stalest first, with a rate-limit bucket check at 70 percent to back off before the limit.
  • Customers: scheduled sync every 15 minutes.
  • Employees: scheduled sync once daily.

Initial imports, customer-item and work-order-item syncing, token refresh, manual refreshes and user-triggered actions are separate from the work-order polling schedule. The 5-minute interval does not mean every API request is held until the next poll. Connection errors and rate-limit backoff can delay updates.

Multiple locations and supported series

Each connected account posts to one configured Lightspeed location. Automatic routing of work orders across multiple locations is not supported. Contact Trail Hits for a configuration review before using a multi-outlet account; a separate-shop arrangement should not be assumed to work without that review.

This reference covers Lightspeed Retail R-Series. It does not describe an X-Series integration.

Need help connecting your shop?

Follow the onboarding guide, book a walkthrough, or email support@trailhits.com.