Lightspeed TypeScript SDK

Build Lightspeed integrations in TypeScript with Apideck's official SDK. Type-safe, well-documented, and production-ready.

Quick Installation

Get started with Lightspeed in TypeScript in under a minute

Terminal

npm install @apideck/node

TypeScriptView on GitHub

import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: process.env.APIDECK_API_KEY!,
  appId: process.env.APIDECK_APP_ID!,
  consumerId: 'user-123'
})

// Connect to Lightspeed
const { data: connections } = await apideck.ecommerce.connectionsAll({
  serviceId: 'lightspeed'
})

// List data from Lightspeed
const response = await apideck.ecommerce.companiesAll({
  serviceId: 'lightspeed'
})

console.log(response.data)

Why use the TypeScript SDK?

Type Safety

Full type definitions for TypeScript. Catch errors at compile time, not runtime.

Auto-generated

SDK is auto-generated from our OpenAPI spec, always up-to-date with the latest API.

Error Handling

Built-in error types and retry logic. Handle rate limits and errors gracefully.

Pagination

Automatic pagination handling. Iterate through large datasets effortlessly.

Authentication

OAuth, API keys, and consumer tokens handled automatically.

Documentation

Comprehensive docs with examples for every endpoint and method.

Lightspeed available in all SDKs

Choose your preferred language

PHP

API Resources

Lightspeed resources available

All these Lightspeed endpoints are accessible via the TypeScript SDK

More Ecommerce connectors

We build and maintain connectors, so you don't have to. View our full list of Ecommerce connectors.
Missing a connector? We're able to add new connectors.