CtrlK
BlogDocsLog inGet started
Tessl Logo

lightspeed-ecommerce

Lightspeed eCom (C-Series) integration via Apideck's Ecommerce unified API — same methods work across every connector in Ecommerce, switch by changing `serviceId`. Use when the user wants to read, write, or sync orders, products, customers, and stores in Lightspeed eCom (C-Series). Routes through Apideck with serviceId "lightspeed-ecommerce".

87

Quality

86%

Does it follow best practices?

Impact

No eval scenarios have been run

SecuritybySnyk

Passed

No known issues

SKILL.md
Quality
Evals
Security

Lightspeed eCom (C-Series) (via Apideck)

Access Lightspeed eCom (C-Series) through Apideck's Ecommerce unified API — one of 17 Ecommerce connectors that share the same method surface. Code you write here ports to Shopify, BigCommerce, Shopify (Public App) and 13 other Ecommerce connectors by changing a single serviceId string. Apideck handles auth, pagination, rate limiting, and retries so you don't write per-tenant Lightspeed eCom (C-Series) plumbing.

Beta connector. Lightspeed eCom (C-Series) is currently in beta on Apideck. Expect partial resource coverage and occasional mapping gaps. Always verify coverage (see below) and fall back to the Proxy API for unsupported operations.

Quick facts

  • Apideck serviceId: lightspeed-ecommerce
  • Unified API: Ecommerce
  • Auth type: basic
  • Status: beta
  • Lightspeed eCom (C-Series) docs: https://developers.lightspeedhq.com
  • Homepage: https://www.lightspeedhq.com/ecommerce

When to use this skill

Activate this skill when the user explicitly wants to work with Lightspeed eCom (C-Series) — for example, "list orders in Lightspeed eCom (C-Series)" or "sync products in Lightspeed eCom (C-Series)". This skill teaches the agent:

  1. Which Apideck unified API covers Lightspeed eCom (C-Series) (Ecommerce)
  2. The correct serviceId to pass on every call (lightspeed-ecommerce)
  3. Lightspeed eCom (C-Series)-specific auth and coverage caveats

For the full method surface (parameters, pagination, filtering), use your language SDK skill:

  • apideck-node, apideck-python, apideck-dotnet, apideck-java, apideck-go, apideck-php, or apideck-rest

For the raw OpenAPI spec:

Minimal example (TypeScript)

import { Apideck } from "@apideck/unify";

const apideck = new Apideck({
  apiKey: process.env.APIDECK_API_KEY,
  appId: process.env.APIDECK_APP_ID,
  consumerId: "your-consumer-id",
});

// List orders in Lightspeed eCom (C-Series)
const { data } = await apideck.ecommerce.orders.list({
  serviceId: "lightspeed-ecommerce",
});

Portable across 17 Ecommerce connectors

The Apideck Ecommerce unified API exposes the same methods for every connector in its catalog. Switching from Lightspeed eCom (C-Series) to another Ecommerce connector is a one-string change — no rewrite, no new SDK.

// Today — Lightspeed eCom (C-Series)
await apideck.ecommerce.orders.list({ serviceId: "lightspeed-ecommerce" });

// Tomorrow — same code, different connector
await apideck.ecommerce.orders.list({ serviceId: "shopify" });
await apideck.ecommerce.orders.list({ serviceId: "bigcommerce" });

This is the compounding advantage of using Apideck over integrating Lightspeed eCom (C-Series) directly: code against the unified Ecommerce API once, gain access to every connector in it. New connectors Apideck adds become available to your app without code changes.

Authentication

  • Type: Basic auth (username/password)
  • Managed by: Apideck Vault — credentials are collected through the Vault modal and stored encrypted server-side.
  • Note: basic auth connectors often require manual rotation by the end user. If auth fails persistently, prompt them to re-enter credentials in Vault.

See apideck-best-practices for Vault setup, connection lifecycle, and handling re-auth flows.

Verifying coverage

Not every Ecommerce operation is supported by every connector. Always verify before assuming a method works:

curl 'https://unify.apideck.com/connector/connectors/lightspeed-ecommerce' \
  -H "Authorization: Bearer ${APIDECK_API_KEY}" \
  -H "x-apideck-app-id: ${APIDECK_APP_ID}"

See apideck-connector-coverage for patterns around UnsupportedOperationError and connector-specific fallbacks.

Escape hatch: Proxy API

When an endpoint isn't covered by the Ecommerce unified API, use Apideck's Proxy to call Lightspeed eCom (C-Series) directly — Apideck injects auth headers and handles token refresh. Set x-apideck-downstream-url to the target endpoint on Lightspeed eCom (C-Series)'s own API:

curl 'https://unify.apideck.com/proxy' \
  -H "Authorization: Bearer ${APIDECK_API_KEY}" \
  -H "x-apideck-app-id: ${APIDECK_APP_ID}" \
  -H "x-apideck-consumer-id: ${CONSUMER_ID}" \
  -H "x-apideck-service-id: lightspeed-ecommerce" \
  -H "x-apideck-downstream-url: <target endpoint on Lightspeed eCom (C-Series)>" \
  -H "x-apideck-downstream-method: GET"

See Lightspeed eCom (C-Series)'s API docs for available endpoints.

Sibling connectors

Other Ecommerce connectors that share this unified API surface (same method signatures, just change serviceId):

shopify (beta), bigcommerce (beta), shopify-public-app (beta), woocommerce (beta), amazon-seller-central (beta), ebay (beta), etsy (beta), magento (beta), and 8 more.

See also

Repository
apideck-libraries/api-skills
Last updated
Created

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.