Download the PHP package dansleboby/lightspeed-xseries-sdk without Composer
On this page you can find all versions of the php package dansleboby/lightspeed-xseries-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download dansleboby/lightspeed-xseries-sdk
More information about dansleboby/lightspeed-xseries-sdk
Files in dansleboby/lightspeed-xseries-sdk
Package lightspeed-xseries-sdk
Short Description PHP SDK for the X‑Series API, generated with Saloon
License MIT
Informations about the package lightspeed-xseries-sdk
Lightspeed Retail (X-Series) API v2.0 - PHP SDK
This repository contains a PHP SDK for interacting with version 2.0 of the Lightspeed Retail (X-Series) API. It is built using the excellent Saloon library to provide a simple and expressive way to make API requests.
⚠️ Disclaimer ⚠️
This SDK is not officially created or supported by Lightspeed. It is an independent, community-driven project.
Furthermore, this software is currently in an alpha stage. This means it may contain bugs, and breaking changes can be introduced at any time. Please use it at your own risk and test thoroughly before using it in a production environment.
Requirements
- PHP 8.1 or higher
- Composer
Installation
You can install the package via Composer:
Quick Start
Here is a basic example of how to list sales.
Available Endpoints
All available API requests are located in the src/Requests directory and are organized by resource (e.g., Products, Customers, Sales). They generally follow a consistent naming pattern:
List{Resource}Get{Resource}ByIdCreate{Resource}Update{Resource}Delete{Resource}
Please browse the src/Requests directory for a complete list of available actions.
Lightspeed API Documentation
For detailed information about specific API endpoints, parameters, and data structures, please refer to the official Lightspeed X-Series API documentation:
License
This SDK is open-source software licensed under the MIT License.