Download the PHP package timothydc/laravel-lightspeed-retail-api without Composer

On this page you can find all versions of the php package timothydc/laravel-lightspeed-retail-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of timothydc/laravel-lightspeed-retail-api

Informations about the package laravel-lightspeed-retail-api

laravel-lightspeed-retail-api

Latest Version on Packagist Total Downloads

Version Guidance

Version PHP Version Lightspeed Version Support
alpha ^7.4 | ^8.0 2 | 3 Unsupported since 2023-11-14
1.0 ^7.4 | ^8.0 2 | 3 Unsupported since 2024-10-21
2.0 ^8.0 2 | 3 New features

This package should be up to date with the Lightspeed API changes from 2024-07-31.

Installation

Via Composer

Usage

For general information on how to use the Lightspeed Retail API, refer to the official documentation.

Register API client

Before creating an API connection, you will need to sign up for an API client with Lightspeed Retail. You can do this via the client portal.

The API client is developer friendly, you can set https://your-domain.test as your redirect URI. Remember the value of your redirect URI, we will need it later on.

Configure .env

After your API client is approved you will receive a key and secret. Add those values to your .env file.

Publish resources

You can publish all resources, or you may choose to publish them separately:

The API tokens are stored in the database, by default. So run your migrations.

Request initial access token

Before we can request an access token you need to connect your Retail POS to this app.

You can manage the access level to your POS data via a scope. Choose a $scope from the options in TimothyDC\LightspeedRetailApi\Scope. More information on the scopes can be found in the documentation.

Via command line

The command will ask you about the scope, and you will get an URL in return. Excellent deal!

Via controller

After requesting your initial access token you will be redirected to the Redirect URI you provided when configuring your client information via the Lightspeed Retail API Client.

Configure routing

Register the following route in your routes/web.php. Update your-redirect-uri with the redirect URI you entered in the API client.

Configure controller

The SaveAccessTokenController will store the initial access token and make follow-up request for the refresh token. Afterwards you will be redirected to RouteServiceProvider::HOME. If you would like to alter the redirect you may extend this controller.

Make API calls

You can now access the API. All resources return a Laravel collection... which means lots of fun!

Note that not all resources are added (yet). Feel free to add them yourself via a pull request! If you would like to filter the GET-results you can look at the query parameters API

Pagination

As of V3 of the Lightspeed Retail API the pagination works cursor based. The full details of on how pagination works, you can find in the Pagination API documentation

To get the next page of the resource, add the 'after' token to your request.

The 'after' attribute will be empty on the last page and the 'before' attribute will be empty on the first page. This is the same as the 'next' and 'previous' attributes as described in the Pagination API documentation

Automatic model synchronisation [optional]

If you would like to automatically synchronise your data to Lightspeed, you can add the HasLightspeedRetailResources trait and the AutomaticSynchronisationInterface interface to your model

In getLightspeedRetailResourceMapping() you want to map your model fields to the Lightspeed resource. The order of the resources is the order of the synchronisation. In the example below we put the manufacturer resource before the product resource because we need the manufacturer id for when we are syncing the product.

In getLightspeedRetailResourceName() you need to define the Lightspeed resource that represents your model. For example:

Don't forget to add the HasLightspeedRetailResources trait to your manufacturer resource too.

You will notice some resources in the mapping have an array value. The first item in the array references the value which will be checked for a change, The second item is the value that will be sent to Lightspeed. It also accepts mutators:

In case of a relationship, the first value is the local foreign key. The second, is the related primary key.

By default, the synchronisation process listens to your model events created, updated and deleted. Update the array if you want to listen to other events.

If you would like to send fields to Lightspeed, even when the value isn't changed. You can add them to the $lsForceSyncFields array.

Change log

Please see the changelog for more information on what has changed recently.

Contributing

Please see contributing.md for details and a todolist.

Security

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

Credits

License

MIT. Please see the license file for more information.

All versions of laravel-lightspeed-retail-api with dependencies

PHP Build Version
Package Version
Requires php Version ^8.0
guzzlehttp/guzzle Version ^7.4.6
ext-json Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package timothydc/laravel-lightspeed-retail-api contains the following files

Loading the files please wait ....