PHPackages king-of-web-designs/laravel-xpos - 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. king-of-web-designs/laravel-xpos ActiveLibrary[API Development](/categories/api) king-of-web-designs/laravel-xpos ================================ This package connects the Xpos till system to a laravel application via the Xpos API v1.0.2(7mo ago)013MITPHPPHP ^8.2 Since Feb 17Pushed 3mo ago1 watchersCompare [ Source](https://github.com/KingOfWebDesigns/laravel-xpos)[ Packagist](https://packagist.org/packages/king-of-web-designs/laravel-xpos)[ Docs](https://github.com/KingOfWebDesigns/laravel-xpos)[ RSS](/packages/king-of-web-designs-laravel-xpos/feed)WikiDiscussions main Synced today READMEChangelog (1)Dependencies (9)Versions (6)Used By (0) This package connects the Xpos till system to a laravel application via the Xpos API ==================================================================================== [](#this-package-connects-the-xpos-till-system-to-a-laravel-application-via-the-xpos-api) [![Latest Version on Packagist](https://camo.githubusercontent.com/2b4f75c75682c9b75a15627c4f30a03a0eadc4abea691d435ab371dd10d34f3d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6b696e672d6f662d7765622d64657369676e732f6c61726176656c2d78706f732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/king-of-web-designs/laravel-xpos)[![GitHub Tests Action Status](https://camo.githubusercontent.com/b87e18680bcccf7705e0d96757478eaa4dc6674b659a760cd74e144dac0a5156/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f4b696e674f6657656244657369676e732f6c61726176656c2d78706f732f72756e2d74657374732e796d6c3f6272616e63683d6d61696e266c6162656c3d7465737473267374796c653d666c61742d737175617265)](https://github.com/kKingOfWebDesigns/laravel-xpos/actions?query=workflow%3Arun-tests+branch%3Amain)[![GitHub Code Style Action Status](https://camo.githubusercontent.com/d5c9470d41c932a8708c5dd0c597b62772bb763d9a65e703d41972a5397043f3/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f4b696e674f6657656244657369676e732f6c61726176656c2d78706f732f6669782d7068702d636f64652d7374796c652d6973737565732e796d6c3f6272616e63683d6d61696e266c6162656c3d636f64652532307374796c65267374796c653d666c61742d737175617265)](https://github.com/KingOfWebDesigns/laravel-xpos/actions?query=workflow%3A%22Fix+PHP+code+style+issues%22+branch%3Amain)[![Total Downloads](https://camo.githubusercontent.com/607a380e936be78e9d63cbe35c9bb9b66290a82c5720a28907b7e42823aa45fe/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f4b696e674f6657656244657369676e732f6c61726176656c2d78706f732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/KingOfWebDesigns/laravel-xpos) This is where your description should go. Limit it to a paragraph or two. Consider adding a small example. King Of Web Designs ------------------- [](#king-of-web-designs) [![](https://camo.githubusercontent.com/c263ebb9abdf940bfa44d31e406621ae6ebaa5657bc8c69edf946175c051800e/68747470733a2f2f7777772e6b696e676f6677656264657369676e732e636f2e756b2f73746f726167652f66696c65732f66696c656d616e616765722f436f6d70616e792f4c6f676f2f4b496e674f6657656244657369676e734c6f676f426f726465722e706e67)](https://spatie.be/github-ad-click/laravel-xpos) Installation ------------ [](#installation) You can install the package via composer: ``` composer require king-of-web-designs/laravel-xpos ``` You can publish and run the migrations with: ``` php artisan vendor:publish --tag="laravel-xpos-migrations" php artisan migrate ``` You can publish the config file with: ``` php artisan vendor:publish --tag="laravel-xpos-config" ``` This is the contents of the published config file: ``` return [ ]; ``` Optionally, you can publish the views using ``` php artisan vendor:publish --tag="laravel-xpos-views" ``` Usage ----- [](#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. ``` use KingOfWebDesigns\LaravelXpos\LaravelXpos; public function useLaravelXpos() { $Xpos = new LaravelXpos(); return $Xpos->sales(); } ``` 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. ``` XPOS_TEST_API_KEY="YOUR API KEY" XPOS_URL="YOUR URL" ``` ### Brands (GET) [](#brands-get) Returns an array of the brands used by the shop. ``` use KingOfWebDesigns\LaravelXpos\LaravelXpos; $Xpos = new LaravelXpos(); $Xpos->brands(); ``` ### Groups (GET) [](#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. ``` use KingOfWebDesigns\LaravelXpos\LaravelXpos; $Xpos = new LaravelXpos(); $Xpos->groups(); ``` ### Customer (GET) - requires: customerid [](#customer-get---requires-customerid) Returns a specific customer record based on the customer id given. Cannot access 'Internal' customers. ``` use KingOfWebDesigns\LaravelXpos\LaravelXpos; $customerID = '1234'; //Get your customer id here. $Xpos = new LaravelXpos(); $Xpos->customer($customerID); ``` ### Customers (GET) - requires: page number (default = 1) [](#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. ``` use KingOfWebDesigns\LaravelXpos\LaravelXpos; $pageNo = '1'; //Get your customer id here. $dateTime = '2025-02-10 11:46:37.933'; $Xpos = new LaravelXpos(); $Xpos->customers($pageNo, $dateTime); ``` ### Inventory (GET) - BROKEN:TO BE FIXED - requires: page number (default = 1) [](#inventory-get---brokento-be-fixed---requires-page-number-default--1) Returns an array of stock levels for matching products in the shop in pages of 25. ``` use KingOfWebDesigns\LaravelXpos\LaravelXpos; $pageNo = '1'; //Get your customer id here. $Xpos = new LaravelXpos(); $Xpos->inventory($pageNo); ``` ### Products (GET) - requires: page number (default = 1) [](#products-get---requires-page-number-default--1) Returns an array of products stock in the shop in pages of 25. ``` use KingOfWebDesigns\LaravelXpos\LaravelXpos; $pageNo = '1'; //Get your customer id here. $Xpos = new LaravelXpos(); $Xpos->products($pageNo); ``` ### Sales (GET) - requires: page number (default = 1) [](#sales-get---requires-page-number-default--1) Returns an array of all sales since a specific date. Only returns completed sales ``` use KingOfWebDesigns\LaravelXpos\LaravelXpos; $pageNo = '1'; //Get your customer id here. $dateTime = '2025-02-10 11:46:37.933'; $Xpos = new LaravelXpos(); $Xpos->sales($pageNo, $dateTime); ``` ### Staff (GET) [](#staff-get) Returns an array of the staff in the shop. ``` use KingOfWebDesigns\LaravelXpos\LaravelXpos; $Xpos = new LaravelXpos(); $Xpos->staff(); ``` ### VatRates (GET) [](#vatrates-get) Returns an array of current VAT Rates in shop. ``` use KingOfWebDesigns\LaravelXpos\LaravelXpos; $Xpos = new LaravelXpos(); $Xpos->vatRates(); ``` Testing ------- [](#testing) ``` composer test ``` Changelog --------- [](#changelog) Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. Contributing ------------ [](#contributing) Please see [CONTRIBUTING](CONTRIBUTING.md) for details. Security Vulnerabilities ------------------------ [](#security-vulnerabilities) Please review [our security policy](../../security/policy) on how to report security vulnerabilities. Credits ------- [](#credits) - [Matthew King - King Of Web Designs](https://github.com/KingOfWebDesigns) - [All Contributors](../../contributors) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 37 — LowBetter than 81% of packages Maintenance72 Regular maintenance activity Popularity5 Limited adoption so far Community7 Small or concentrated contributor base Maturity54 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% 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 ~97 days Total 5 Last Release 114d ago Major Versions v0.1.0-alpha → v1.0.02025-02-17 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/199611567?v=4)[KingOfWebDesigns](/maintainers/KingOfWebDesigns)[@KingOfWebDesigns](https://github.com/KingOfWebDesigns) --- Top Contributors [![kinger251285](https://avatars.githubusercontent.com/u/44111958?v=4)](https://github.com/kinger251285 "kinger251285 (12 commits)") --- Tags laravelKing Of Web Designslaravel-xpos ### Code Quality TestsPest Code StyleLaravel Pint ### Embed Badge ![Health badge](/badges/king-of-web-designs-laravel-xpos/health.svg) ``` [![Health](https://phpackages.com/badges/king-of-web-designs-laravel-xpos/health.svg)](https://phpackages.com/packages/king-of-web-designs-laravel-xpos) ``` ### Alternatives [dedoc/scramble Automatic generation of API documentation for Laravel applications. 2.1k11.2M101](/packages/dedoc-scramble)[simplestats-io/laravel-client Server-side analytics for Laravel that follows the full funnel from visit to registration to payment, attributed to the channel that drove it. Revenue, MRR, churn and ad-spend profit (ROAS/CAC) per channel. GDPR compliant, ad-blocker proof. 5022.0k](/packages/simplestats-io-laravel-client)[spatie/laravel-health Monitor the health of a Laravel application 87512.0M167](/packages/spatie-laravel-health)[spatie/laravel-pdf Create PDFs in Laravel apps 1.0k4.8M47](/packages/spatie-laravel-pdf)[defstudio/telegraph A laravel facade to interact with Telegram Bots 816333.9k3](/packages/defstudio-telegraph)[codebar-ag/laravel-docuware DocuWare integration with Laravel 1123.7k](/packages/codebar-ag-laravel-docuware) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)