Connect your Lightspeed eCom store to EcomCentral using HTTP Basic authentication with your API key and secret.
Lightspeed eCom (C-Series) is the cloud-hosted e-commerce platform formerly
known as SEOshop, available at shoplightspeed.com (US) and
webshopapp.com (EU). It is sometimes called the eCom product within
the Lightspeed family.
The API is available in two clusters:
https://api.webshopapp.com/{lang}/https://api.shoplightspeed.com/{lang}/
The {lang} segment is your store's language code, e.g. en,
nl, or us. All endpoints end in .json.
https://api.webshopapp.com) or US (https://api.shoplightspeed.com) to match your store's region| Key | Required | Description | Example |
|---|---|---|---|
api_key |
Required | API key from Store Settings → Developers. Used as the HTTP Basic username. | d3f4a1b2c… |
api_secret |
Required | API secret paired with the key. Used as the HTTP Basic password. | •••••••• |
cluster |
Optional | Cluster host. Use https://api.webshopapp.com for EU stores (default) or https://api.shoplightspeed.com for US stores. |
https://api.webshopapp.com |
lang |
Optional | Store language segment used in every API path. Defaults to en. Must match your shop's language setting. |
en, nl, us |
apiKey or key for the API key;
apiSecret or secret for the API secret; base_url for the cluster;
language for the lang segment.
| Operation | Method | Endpoint |
|---|---|---|
| Test connection | GET | /account.json |
| List orders | GET | /orders.json?page=P&limit=N |
| Order detail | GET | /orders/{id}.json |
| List products / stock | GET | /variants.json?page=P&limit=N |
| Product detail | GET | /products/{id}.json |
| Get shipments for order | GET | /shipments.json?order={id} |
| Add tracking (update shipment) | PUT | /shipments/{shipment_id}.json with {"shipment":{"trackingCode":"…","status":"shipped"}} |
| Update variant stock | PUT | /variants/{variant_id}.json with {"variant":{"stockLevel":N}} |
{"orders":[…]}, {"variants":[…]}.
Single-item responses wrap the object: {"order":{…}}, {"product":{…}}.
Lightspeed eCom has no "create shipment" API endpoint. Shipment objects are
generated internally by Lightspeed when an order is processed. Tracking codes are written by
updating an existing shipment object with a PUT /shipments/{id}.json call.
The Lightspeed eCom API does not expose a carrier field on shipments — only
trackingCode can be set via the API.
In Lightspeed eCom, SKU, price, and stock level are variant fields, not product fields. Every product has one or more variants. EcomCentral lists variants in the Products view so that each row carries a SKU, price, and stock quantity directly.
PUT /variants/{id}.json with the new stockLevel.
Lightspeed eCom uses two status fields per order: status (payment / fulfillment
lifecycle) and shipmentStatus (shipping state). EcomCentral shows both with
colour-coded badges.
| Status value | Field | Badge colour |
|---|---|---|
| complete / shipped / paid / delivered | either | Green |
| new / pending / open / processing | either | Blue |
| partially_shipped / on_hold / not_shipped | shipmentStatus | Amber |
| cancelled / refunded / void | either | Red |
| Feature | Supported | Notes |
|---|---|---|
| View orders (paginated) | ✅ | Order ID, date, status, total |
| View order detail | ✅ | Customer info, billing & shipping addresses, line items, shipping cost, shipment status, existing tracking |
| View products (paginated) | ✅ | Listed via variants — each row carries SKU, price, stock |
| View product detail | ✅ | Product title, brand, EAN, image, description (HTML stripped), full variant table |
| Add tracking number | ✅ | Requires an existing shipment object — mark order shipped in Lightspeed first |
| Update stock | ✅ | Per variant SKU via PUT /variants/{id}.json |
| Test connection | ✅ | Hits GET /account.json — success confirms key, secret, and cluster are correct |
The api_key or api_secret is wrong, or the application has been
revoked. Regenerate a new key/secret in Store Settings → Developers and update the
connection in EcomCentral.
Your credentials are correct but the cluster is wrong. EU stores use
https://api.webshopapp.com; US stores use
https://api.shoplightspeed.com. Update the cluster field and retry.
The order or product id does not exist in your store, or the lang segment is
incorrect. Verify the resource exists and that the language code matches your store setting
(e.g. en, nl, us).
Lightspeed eCom does not expose a create-shipment endpoint. Open the order in your Lightspeed back-office, mark it as ready for shipment (or complete the fulfilment workflow), then return to EcomCentral to attach the tracking number.
https://api.webshopapp.com/en/account.json (or the US equivalent) in a browser.
A 401 response with JSON means the endpoint is reachable — enter your credentials.
A connection timeout or HTML error page suggests a wrong cluster URL.