Download the PHP package king-of-web-designs/laravel-xpos without Composer
On this page you can find all versions of the php package king-of-web-designs/laravel-xpos. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download king-of-web-designs/laravel-xpos
More information about king-of-web-designs/laravel-xpos
Files in king-of-web-designs/laravel-xpos
Package laravel-xpos
Short Description This package connects the Xpos till system to a laravel application via the Xpos API
License MIT
Homepage https://github.com/KingOfWebDesigns/laravel-xpos
Informations about the package laravel-xpos
This package connects the Xpos till system to a laravel application via the Xpos API
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
King Of Web Designs
Installation
You can install the package via composer:
You can publish and run the migrations with:
You can publish the config file with:
This is the contents of the published config file:
Optionally, you can publish the views using
Usage
Basic usage. Add the use statement at the top of your controller or wherever you wish to use the packge. Then call the function along with call function required (listed below) to return an array of that data.
In your .env file include the variables XPOS_TEST_API_KEY and XPOS_URL. A future release will add a test mode and a live test key & url.
Please contact XPOS directly for your shop API URL and API Key.
Brands (GET)
Returns an array of the brands used by the shop.
Groups (GET)
Returns an array for the Groups used by the shop. Groups are held in a 3 tier structure. Where ParentGroupID is null, the group is a root. It can have any number of child groups beneath it where the ParentGroupID of another group equals the GroupID of the root node. These children are linked to other groups in the same way.
Root Nodes are known as “Departments“ in Xpos cloud. Their children are “Product Groups” and the grand children are “Sub Groups”. Products are only ever linked to Sub Groups via the GroupID property in products.
Customer (GET) - requires: customerid
Returns a specific customer record based on the customer id given. Cannot access 'Internal' customers.
Customers (GET) - requires: page number (default = 1)
Returns an array customers in pages of 25 records. Cannot access ‘Internal’ customers.
Pass the page number and a date to return further pages and customers based on the the 'Last Adjusted Date' field. The date passed will return records before this date.
Inventory (GET) - BROKEN:TO BE FIXED - requires: page number (default = 1)
Returns an array of stock levels for matching products in the shop in pages of 25.
Products (GET) - requires: page number (default = 1)
Returns an array of products stock in the shop in pages of 25.
Sales (GET) - requires: page number (default = 1)
Returns an array of all sales since a specific date. Only returns completed sales
Staff (GET)
Returns an array of the staff in the shop.
VatRates (GET)
Returns an array of current VAT Rates in shop.
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Matthew King - King Of Web Designs
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-xpos with dependencies
guzzlehttp/guzzle Version ^7.9
illuminate/contracts Version ^10.0||^11.0
spatie/laravel-package-tools Version ^1.16