Download the PHP package pashkevich/loyverse-sdk without Composer
On this page you can find all versions of the php package pashkevich/loyverse-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download pashkevich/loyverse-sdk
More information about pashkevich/loyverse-sdk
Files in pashkevich/loyverse-sdk
Package loyverse-sdk
Short Description A simple to use PHP class to work with the Loyverse API
License MIT
Homepage https://github.com/siarheipashkevich/loyverse-sdk
FAQ
Example:
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 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.
Informations about the package loyverse-sdk
Loyverse SDK
To work with this package, firstly you must have a Loyverse account, and secondly you must create an API token through Loyverse itself.
- Documentation
- Installation
- Basic Usage
- Managing Categories
- Managing Customers
- Managing Discounts
- Managing Employees
- Managing Inventory
- Managing Items
- Managing Merchants
- Managing Modifiers
- Managing Payment Types
- Managing Pos Devices
- Managing Receipts
- Managing Shifts
- Managing Stores
- Managing Suppliers
- Managing Taxes
- Managing Variants
- Managing Webhooks
- Testing
- Contributing
- Security Vulnerabilities
- Credits
- License
Documentation
Installation
To install the SDK in your project you need to require the package via composer:
Basic Usage
You can create an instance of the SDK like so:
Using the Loyverse instance you may perform multiple actions as well as retrieve the different resources Loyverse's
API provides:
This will give you an array of categories that you have access to, where each category is represented by an instance
of Pashkevich\Loyverse\Resources\Category, this instance has multiple public properties like $id, $name, $color
, and others.
You may also retrieve a single category using:
On multiple actions supported by this SDK you may need to pass some parameters, for example when creating a new category:
These parameters will be used in the POST request sent to Loyverse servers, you can find more information about the parameters needed for each action on Loyverse's official API documentation.
You can also set the desired timeout value:
Managing Categories
On a Category instance you may also call:
Managing Customers
On a Customer instance you may also call:
Managing Discounts
On a Discount instance you may also call:
Managing Employees
Managing Inventory
Managing Items
On a Item instance you may also call:
Managing Merchants
Managing Modifiers
On a Modifier instance you may also call:
Managing Payment Types
Managing Pos Devices
On a PosDevice instance you may also call:
Managing Receipts
On a Receipt instance you may also call:
Managing Shifts
Managing Stores
Managing Suppliers
On a Supplier instance you may also call:
Managing Taxes
On a Tax instance you may also call:
Managing Variants
On a Variant instance you may also call:
Managing Webhooks
On a Webhook instance you may also call:
Testing
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
License
Loyverse SDK is open-sourced software licensed under the MIT license.
