PHPackages                             timothydc/laravel-lightspeed-ecom-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. timothydc/laravel-lightspeed-ecom-api

ActiveLibrary[API Development](/categories/api)

timothydc/laravel-lightspeed-ecom-api
=====================================

Connect with the Lightspeed eCom API

v1.7.0(1y ago)32.3k↑1166.7%2[2 issues](https://github.com/timothydc/laravel-lightspeed-ecom-api/issues)1MITPHPPHP ^7.4|^8.0CI failing

Since Jul 29Pushed 1y ago1 watchersCompare

[ Source](https://github.com/timothydc/laravel-lightspeed-ecom-api)[ Packagist](https://packagist.org/packages/timothydc/laravel-lightspeed-ecom-api)[ Docs](https://github.com/timothydc/laravel-lightspeed-ecom-api)[ RSS](/packages/timothydc-laravel-lightspeed-ecom-api/feed)WikiDiscussions master Synced 3w ago

READMEChangelog (9)Dependencies (5)Versions (11)Used By (1)

Connect with the Lightspeed eCom API
====================================

[](#connect-with-the-lightspeed-ecom-api)

[![Latest Version on Packagist](https://camo.githubusercontent.com/71bf1895ac96da9bf80816fd0ade1513844b563333e842e3930df23dfc10502b/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f74696d6f74687964632f6c61726176656c2d6c6967687473706565642d65636f6d2d6170692e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/timothydc/laravel-lightspeed-ecom-api)[![Total Downloads](https://camo.githubusercontent.com/71a3290fc3e88897ee8093de558b7dac11064014565f4dd6f360eb97d9f7e773/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f74696d6f74687964632f6c61726176656c2d6c6967687473706565642d65636f6d2d6170692e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/timothydc/laravel-lightspeed-ecom-api)[![Github Tests Action Tests](https://camo.githubusercontent.com/3260d94ca40149a520fcc32abfb7e03a730250feb726fb4a986858e49e442c26/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f776f726b666c6f772f7374617475732f74696d6f74687964632f6c61726176656c2d6c6967687473706565642d65636f6d2d6170692f72756e2d74657374733f6c6162656c3d7465737473267374796c653d666c61742d737175617265)](https://github.com/timothydc/laravel-lightspeed-ecom-api/actions?query=workflow%3Arun-tests+branch%3Amaster)[![Github Tests Action Styling](https://camo.githubusercontent.com/b5f95392224ac3843568f78ec01d68821b32db3060e34fc21f1debd5cbefe360/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f776f726b666c6f772f7374617475732f74696d6f74687964632f6c61726176656c2d6c6967687473706565642d65636f6d2d6170692f6669782d7374796c696e673f6c6162656c3d7374796c696e67267374796c653d666c61742d737175617265)](https://github.com/timothydc/laravel-lightspeed-ecom-api/actions?query=workflow%3Afix-styling+branch%3Amaster)

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Installation
------------

[](#installation)

Via Composer:

```
composer require timothydc/laravel-lightspeed-ecom-api
```

Configuration
-------------

[](#configuration)

You can publish the config file with:

```
php artisan vendor:publish --tag=lightspeed-ecom-api:config
```

Usage
-----

[](#usage)

Interaction works the same as the Lightspeed API.

#### Authentication

[](#authentication)

```
// change API language
LightspeedEcomApi::setLanguage('en');

// change API key and secret
LightspeedEcomApi::setCredentials('key', 'secret');
```

#### Rate limits

[](#rate-limits)

By default, each API key caches its remaining calls and next reset time. If you would like to disable this behavior, deactive this feature by setting `save_remaining_calls_to_cache` to `false` in `config/lightspeed-ecom-api.php`.

```
// get max calls for your API keys
LightspeedEcomApi::getMaxCalls();

// get Carbon with next reset time - from the cache
LightspeedEcomApi::getResetTime();

// get Carbon with next reset time - from the last API response header
LightspeedEcomApi::getResetTime(false);

// get available API limits - from the cache
LightspeedEcomApi::getRemainingCalls();

// get available API limits - from the last API response header
LightspeedEcomApi::getRemainingCalls(false);
```

#### Calling resources

[](#calling-resources)

```
// get products
LightspeedEcomApi::products()->get();

// get single product
LightspeedEcomApi::products()->get(123456789);

// get filtered products
LightspeedEcomApi::products()->get(null, ['limit' => 250, 'page' => 1, 'since_id' => 123]);

// create product
LightspeedEcomApi::products()->create(['title' => 'my product']);

// update product
LightspeedEcomApi::products()->update(123456789, ['title' => 'my other product']);
```

Testing
-------

[](#testing)

```
composer test
```

Security
--------

[](#security)

If you discover any security related issues, please email  instead of using the issue tracker.

Credits
-------

[](#credits)

- [Timothy De Cort](https://github.com/timothydc)
- [Gunharth](https://github.com/gunharth) ()
- [All Contributors](../../contributors)

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

38

—

LowBetter than 83% of packages

Maintenance31

Infrequent updates — may be unmaintained

Popularity27

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity66

Established project with proven stability

 Bus Factor1

Top contributor holds 82.4% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~214 days

Recently: every ~312 days

Total

9

Last Release

444d ago

PHP version history (2 changes)v1.0.0PHP ^7.4

v1.3.0PHP ^7.4|^8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/b19824d74959d87bb9c166a27875496cc58e9cc49e10fb551dea3d65f2bf30ad?d=identicon)[timothydc](/maintainers/timothydc)

---

Top Contributors

[![timothydc](https://avatars.githubusercontent.com/u/13786303?v=4)](https://github.com/timothydc "timothydc (14 commits)")[![TVke](https://avatars.githubusercontent.com/u/15680337?v=4)](https://github.com/TVke "TVke (2 commits)")[![mvd81](https://avatars.githubusercontent.com/u/5435962?v=4)](https://github.com/mvd81 "mvd81 (1 commits)")

---

Tags

apiecommercelaravellightspeedlaravellightspeedecomtimothydc

###  Code Quality

TestsPHPUnit

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/timothydc-laravel-lightspeed-ecom-api/health.svg)

```
[![Health](https://phpackages.com/badges/timothydc-laravel-lightspeed-ecom-api/health.svg)](https://phpackages.com/packages/timothydc-laravel-lightspeed-ecom-api)
```

###  Alternatives

[defstudio/telegraph

A laravel facade to interact with Telegram Bots

815320.5k3](/packages/defstudio-telegraph)[riclep/laravel-storyblok

A Laravel wrapper around the Storyblok API to provide a familiar experience for Laravel devs

6277.0k5](/packages/riclep-laravel-storyblok)[simplestats-io/laravel-client

Analytics for Laravel. Track visitors, registrations, and payments. Discover which channels actually drive revenue, not just traffic. Server-side, GDPR compliant, ad-blocker proof.

5019.3k](/packages/simplestats-io-laravel-client)[timothydc/laravel-lightspeed-retail-api

Laravel package for Lightspeed Retail API

121.1k](/packages/timothydc-laravel-lightspeed-retail-api)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
