PHPackages aimeos/aimeos-headless - 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. aimeos/aimeos-headless ActiveProject[API Development](/categories/api) aimeos/aimeos-headless ====================== Aimeos headless ecommerce system 2025.10.1(6mo ago)2.5k2.3k↓100%26[1 PRs](https://github.com/aimeos/aimeos-headless/pulls)MITJavaScriptPHP ^8.1CI passing Since Apr 14Pushed 2mo ago2 watchersCompare [ Source](https://github.com/aimeos/aimeos-headless)[ Packagist](https://packagist.org/packages/aimeos/aimeos-headless)[ RSS](/packages/aimeos-aimeos-headless/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependencies (18)Versions (25)Used By (0) [ ![Aimeos logo](https://camo.githubusercontent.com/e55b7a8426f14ba6040d604746b03b7e096af41ede8fead0ea817cbb8d60f998/68747470733a2f2f61696d656f732e6f72672f66696c6561646d696e2f74656d706c6174652f69636f6e732f6c6f676f2e706e67 "Aimeos")](https://aimeos.org/)Aimeos headless distribution ============================ [](#aimeos-headless-distribution) ⭐ Star us on GitHub — it motivates a lot! [Aimeos](https://aimeos.org/Laravel) is THE ultra-fast, cloud-native and API-first headless ecommerce for Laravel! You can adapt, extend, overwrite and customize anything to your needs. Features -------- [](#features) Aimeos is a full-featured e-commerce package: - JSON REST API based on jsonapi.org - GraphQL API for administration - Perfect fit for AWS, Google, Azure and Kubernetes based clouds - Multi vendor, multi channel and multi warehouse - From one to 1,000,000,000+ items - Extremly fast down to 20ms - For multi-tentant e-commerce SaaS solutions with unlimited vendors - Bundles, vouchers, virtual, configurable, custom and event products - Subscriptions with recurring payments - Block/tier pricing out of the box - Extension for customer/group based prices - Discount and voucher support - Flexible basket rule system - Full-featured admin backend - Beautiful admin dashboard - Configurable product data sets - Completly modular structure - Extremely configurable and extensible - Extension for market places with millions of vendors - Translated to 30+ languages - Full RTL support - AI-based text translation - Secure and reviewed implementation - High quality source code ... and [more Aimeos features](https://aimeos.org/features) Supported languages: [![](https://camo.githubusercontent.com/7b82ad7f6a63cc958f4a3f03801f262e01d7c5e221f02f6da4af93982d498745/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f75732e737667 "English")](https://www.transifex.com/aimeos/) [![](https://camo.githubusercontent.com/8c45778723c7b34d34403b8d0a9b7868864a1d53a57fbda201707a4bf5ff4f2c/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f64652e737667 "German")](https://www.transifex.com/aimeos/dashboard/all_projects/de/) [![](https://camo.githubusercontent.com/7ae837a7dd1ba865446bf0aaab4bab19dce4b481131b232121d1e35fe09fef61/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f66722e737667 "French")](https://www.transifex.com/aimeos/dashboard/all_projects/fr/) [![](https://camo.githubusercontent.com/5240d290d1437d6ed9cc5ee6db3af510a00f56f015ff1089f583d8be846f80f7/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f65732e737667 "Spanish")](https://www.transifex.com/aimeos/dashboard/all_projects/es/) [![](https://camo.githubusercontent.com/362291cf9c6ef00d12adccbe51077e2ee710efaba5b180d2764487296b5ac0d7/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f6e6c2e737667 "Dutch")](https://www.transifex.com/aimeos/dashboard/all_projects/nl/) [![](https://camo.githubusercontent.com/495942f248b284e5d9c977d1362da393a87dd58d73d94987a8af3c085ade7002/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f69742e737667 "Italian")](https://www.transifex.com/aimeos/dashboard/all_projects/it/) [![](https://camo.githubusercontent.com/ea4227ce49fef234e3d84aff3c67eb9d21c62e9a9a6812a3ee9f9e764dfa5421/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f70742e737667 "Portuguese")](https://www.transifex.com/aimeos/dashboard/all_projects/pt/) [![](https://camo.githubusercontent.com/cf98afdbf9ccbc59f2f3d774f24f9c719783580267f91e74eb80874e509b0197/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f646b2e737667 "Danish")](https://www.transifex.com/aimeos/dashboard/all_projects/da/) [![](https://camo.githubusercontent.com/59be3d308795a437dd67b3c314f3fb2764472a840fca8c26354610dc4f8739a5/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f66692e737667 "Finnish")](https://www.transifex.com/aimeos/dashboard/all_projects/fi/) [![](https://camo.githubusercontent.com/7101c35fc88d9c1b1b6bc107db28ed7570e008bb9e819a67d99046e5d692091f/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f73762e737667 "Swedish")](https://www.transifex.com/aimeos/dashboard/all_projects/sv/) [![](https://camo.githubusercontent.com/4c985a010cff153cb4a3fb05b0f5627163e9debef8bf433acd8ef51afe475472/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f6e6f2e737667 "Norwegian")](https://www.transifex.com/aimeos/dashboard/all_projects/no/) [![](https://camo.githubusercontent.com/82a3d108d74815549f020f652a9c8cc6dde10876fa8239e7cb90aa09ee69f040/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f706c2e737667 "Polish")](https://www.transifex.com/aimeos/dashboard/all_projects/pl/) [![](https://camo.githubusercontent.com/b81543ecd73ee705fed3da05b0e8b39882936492bb13f97a6f108c109e8cac69/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f68752e737667 "Hungarian")](https://www.transifex.com/aimeos/dashboard/all_projects/hu/) [![](https://camo.githubusercontent.com/82c0f3645f0c888e75c0bd66d4ab77c628e1a7e571de6977b2033dbc3f91c999/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f72752e737667 "Russian")](https://www.transifex.com/aimeos/dashboard/all_projects/ru/) [![](https://camo.githubusercontent.com/ae0008470efc7ff226b55bed6a709cfce36eb7e00ce274071d716ce091f13555/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f75612e737667 "Ukrainian")](https://www.transifex.com/aimeos/dashboard/all_projects/uk/) [![](https://camo.githubusercontent.com/542c34fbb5939e5550ab9639a377f5abf609f5a20b719916e95ba4deed579865/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f68722e737667 "Croatian")](https://www.transifex.com/aimeos/dashboard/all_projects/hr/) [![](https://camo.githubusercontent.com/bd688239eb89a2dd8b6ddb71be72530c92ca7a7f8534b72b32735419ebd65c1a/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f736c2e737667 "Slovenian")](https://www.transifex.com/aimeos/dashboard/all_projects/sl/) [![](https://camo.githubusercontent.com/1b249ff6be27209a1450dcda3c44af17176c941d5f191c91e8310f87453894fc/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f726f2e737667 "Romanian")](https://www.transifex.com/aimeos/dashboard/all_projects/ro/) [![](https://camo.githubusercontent.com/46043803c2e604ac11864dcef734cfea233c0ac80ed99783711cfc431b2e753c/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f637a2e737667 "Czech")](https://www.transifex.com/aimeos/dashboard/all_projects/cs/) [![](https://camo.githubusercontent.com/5d9f7ef8b0b898bc373b416829dd494c6f5f0c66d86480361ec548f7adac8b3c/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f73722e737667 "Serbian")](https://www.transifex.com/aimeos/dashboard/all_projects/sr/) [![](https://camo.githubusercontent.com/de4f8dae436b358581e151951b34fbe6fc8d47e07fa9634832d95ba5e49e7196/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f736b2e737667 "Slovak")](https://www.transifex.com/aimeos/dashboard/all_projects/sk/) [![](https://camo.githubusercontent.com/ad94639d758bd7d54f85addd769ca91dbb0a01e3685c190eca0c724f3d815dfb/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f65742e737667 "Estonian")](https://www.transifex.com/aimeos/dashboard/all_projects/et/) [![](https://camo.githubusercontent.com/efb74a0fa8eaba85d57154c96449a18da16c67e995e1db979310112ead00fb13/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f6c762e737667 "Latvian")](https://www.transifex.com/aimeos/dashboard/all_projects/lv/) [![](https://camo.githubusercontent.com/6008745ddd2e5141a863d946473dc297b0faf821ff10b20b53534e85c72f73a5/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f74722e737667 "Turkish")](https://www.transifex.com/aimeos/dashboard/all_projects/tr/) [![](https://camo.githubusercontent.com/ae262346f0c7fcc9971d3eb5d6f593ec7e838a372733774dc2b3e955b479162b/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f73612e737667 "Arabic")](https://www.transifex.com/aimeos/dashboard/all_projects/ar/) [![](https://camo.githubusercontent.com/f482eb5dc50f4395c280795eaadce10a9936f493d7059b60d303214c6010667c/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f69722e737667 "Persian")](https://www.transifex.com/aimeos/dashboard/all_projects/fa/) [![](https://camo.githubusercontent.com/7d358918d2b94d265b15cfe4ea834e564f3732f0dfbc8338ac72720e426d66ff/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f636e2e737667 "Chinese")](https://www.transifex.com/aimeos/dashboard/all_projects/zh/) [![](https://camo.githubusercontent.com/bbfa33cff1b3d50f4a498f4eae5825d541be46a2534b8370ef884f6dd41ee1ab/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f6a702e737667 "Japanese")](https://www.transifex.com/aimeos/dashboard/all_projects/ja/) [![](https://camo.githubusercontent.com/ee720e3023ff9bf5609ead346f290561d4db14247f200cffd841023370e2e5d0/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f69642e737667 "Indonesian")](https://www.transifex.com/aimeos/dashboard/all_projects/id/) [![](https://camo.githubusercontent.com/1d49f7fc2e78bbfa91db5140657d7034365851a3a6e682c89da232d279ba9f75/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f76692e737667 "Vietnamese")](https://www.transifex.com/aimeos/dashboard/all_projects/vi/) [![](https://camo.githubusercontent.com/cf951f93d1d035de6358170c717a8b230546c16de66d5fdf6e5dfeb30a302cb5/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f6d792e737667 "Burmese")](https://www.transifex.com/aimeos/dashboard/all_projects/my/) [![](https://camo.githubusercontent.com/c7ad5f84e33377cb7a204c9729587a444ce0bdfc3dd36f3515d9cbe848e5a6ef/68747470733a2f2f666c616769636f6e732e6c697069732e6465762f666c6167732f3478332f6b722e737667 "Korean")](https://www.transifex.com/aimeos/dashboard/all_projects/ko/) Check out the demos: - [Aimeos frontend demo](https://laravel.demo.aimeos.org) - [Aimeos admin demo](https://admin.demo.aimeos.org) Alternatives ------------ [](#alternatives) ### Integrate into existing applications [](#integrate-into-existing-applications) You already have an existing Laravel application and want to add a shop to your web site? Install the Aimeos composer package for Laravel and add e-commerce to your existing application in minutes: ⭐ [Aimeos Laravel package](https://github.com/aimeos/aimeos-laravel) ### Full shop application [](#full-shop-application) If you want to set up a new application or test Aimeos, we recommend the Aimeos shop distribution. It contains everything for a quick start and you will get a fully working online shop in less than 5 minutes: ⭐ [Aimeos shop distribution](https://github.com/aimeos/aimeos) Table of content ---------------- [](#table-of-content) - [Requirements](#requirements) - [Installation](#installation) - [Frontend](#frontend) - [Backend](#backend) - [Customize](#customize) - [Multi-vendor](#multi-vendor) - [License](#license) - [Links](#links) Requirements ------------ [](#requirements) The Aimeos headless distribution requires: - AWS, Google, Azure or Kubernetes cloud, Linux/Unix, WAMP/XAMP or MacOS environment - PHP >= 8.2 - MySQL >= 5.7.8, MariaDB >= 10.2.2, PostgreSQL 9.6+, SQL Server 2019+ - Web server (Apache, Nginx or integrated PHP web server for testing) If required PHP extensions are missing, `composer` will tell you about the missing dependencies. If you want to upgrade between major versions, please have a look into the [upgrade guide](https://aimeos.org/docs/latest/laravel/setup/#upgrade)! Installation ------------ [](#installation) To install the Aimeos shop application, you need [composer 2.2+](https://getcomposer.org). On the CLI, execute this command for a complete installation including a working setup: ``` wget https://getcomposer.org/download/latest-stable/composer.phar -O composer php composer create-project aimeos/aimeos-headless headless ``` You will be asked for the parameters of your database and mail server as well as an e-mail and password used for creating the administration account. In a local environment, you can use the integrated PHP web server to test your new Aimeos installation. Simply execute the following command to start the web server: ``` cd headless php artisan serve ``` **Note:** In an hosting environment, the document root of your virtual host must point to the **/.../headless/public/** directory and you have to change the `APP_URL` setting in your `.env`file to your domain without port, e.g.: ``` APP_URL=http://myhostingdomain.com ``` JSON REST API ------------- [](#json-rest-api) After the installation, you can test the Aimeos JSON REST API by calling the URL of your VHost in your browser. If you use the integrated PHP web server, you should browse this URL: Learn how to use the [JSON REST API](https://aimeos.org/docs/latest/frontend/jsonapi/) ### Authenticate [](#authenticate) To authenticate using e-mail and password, send a POST request: ``` curl -X POST "http://127.0.0.1:8000/api/login?email=me@localhost&password=test" ``` If the authentication was successful, the API will return with a response like this: ``` {"access_token":"eyJ0eXAiOiJKV...","token_type":"bearer","expires_in":3600} ``` Use this access token in all further requests as HTTP header: ``` curl -X POST "http://127.0.0.1:8000/api/me" -H "Authorization: Bearer eyJ0eXAiOiJKV..." ``` Backend ------- [](#backend) The Aimeos administration interface will be available at `/admin` in your VHost. When using the integrated PHP web server, call this URL: [![Aimeos admin backend](https://camo.githubusercontent.com/c2e89c5358a1167c82f37a261f4830083575b4b553dd66b53a91593e67cf7198/68747470733a2f2f61696d656f732e6f72672f66696c6561646d696e2f61696d656f732e6f72672f696d616765732f61696d656f732d6261636b656e642e706e673f323032312e3034)](http://admin.demo.aimeos.org/) Cloud filesystems ----------------- [](#cloud-filesystems) To use cloud storage like AWS S3 compatible object storages, adapt the `resource/fs` sections in the `./config/shop.php` file and configure the filesystem like this: ``` composer req ai-filesystem league/flysystem-aws-s3-v3 ``` ``` 'fs' => [ 'adapter' => 'FlyAwsS3', 'credentials' => [ 'key' => 'your-key', 'secret' => 'your-secret', ], 'region' => 'your-region', 'version' => 'latest|api-version', 'bucket' => 'your-bucket-name', 'prefix' => 'your-prefix', // optional 'baseurl' => 's3-domain-and-path' ], ``` For Azure Blob storage use: ``` composer req ai-filesystem league/flysystem-azure-blob-storage ``` ``` 'fs' => [ 'adapter' => 'FlyAzure', 'endpoint' => 'DefaultEndpointsProtocol=https;AccountName=your-account;AccountKey=your-api-key', 'container' => 'your-container', 'prefix' => 'your-prefix', // optional 'baseurl' => 'azure-domain-and-path' ], ``` And for Google Cloud storage: ``` composer req ai-filesystem league/flysystem-google-cloud-storage ``` ``` 'fs' => [ 'adapter' => 'FlyGoogleCloud', 'keyFile' => json_decode(file_get_contents('/path/to/keyfile.json'), true), // alternative 'keyFilePath' => '/path/to/keyfile.json', // alternative 'projectId' => 'myProject', // alternative 'prefix' => 'your-prefix' // optional 'baseurl' => 'gcloud-domain-and-path' ], ``` Customize --------- [](#customize) Laravel and the Aimeos headless ecommerce distribution are extremely flexible and highly customizable. A lot of documentation for the [Laravel framework](https://laravel.com) and the [Aimeos ecommerce framework](https://aimeos.org/docs/latest/) exists. If you have questions about Aimeos, don't hesitate to ask in our [Aimeos forum](https://aimeos.org/help/). License ------- [](#license) The Aimeos shop system is licensed under the terms of the MIT and LGPLv3 license and is available for free. Links ----- [](#links) - [Web site](https://aimeos.org/Laravel) - [Documentation](https://aimeos.org/docs/latest/) - [Forum](https://aimeos.org/help/) - [Issue tracker](https://github.com/aimeos/aimeos-headless/issues) - [Composer packages](https://packagist.org/packages/aimeos/aimeos-headless) - [Source code](https://github.com/aimeos/aimeos-headless) ### Health Score 56 — FairBetter than 97% of packages Maintenance83 Actively maintained with recent releases Popularity44 Moderate usage in the ecosystem Community16 Small or concentrated contributor base Maturity67 Established project with proven stability Bus Factor1 Top contributor holds 77.7% 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 ~63 days Total 22 Last Release 158d ago Major Versions 2022.10.x-dev → 2023.01.x-dev2023-01-17 2023.10.x-dev → 2024.04.12024-04-18 2024.10.x-dev → 2025.04.12025-04-03 PHP version history (3 changes)2022.04.1PHP ^8.0.2 2022.10.1PHP ^8.0.10 2023.04.1PHP ^8.1 ### Community Maintainers ![](https://www.gravatar.com/avatar/ccdc84033584516c77fb6aa7f85dc7048f2fbcd08867fc6abf115d094bab5eef?d=identicon)[aimeos](/maintainers/aimeos) --- Top Contributors [![aimeos](https://avatars.githubusercontent.com/u/8647429?v=4)](https://github.com/aimeos "aimeos (80 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (22 commits)")[![danialrp](https://avatars.githubusercontent.com/u/13728865?v=4)](https://github.com/danialrp "danialrp (1 commits)") --- Tags apicloudecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlesslaravelmicroservicephpshopvueapilaravelcloudheadlessshopecommerceaimeosdistribution ### Code Quality TestsPHPUnit Code StyleLaravel Pint ### Embed Badge ![Health badge](/badges/aimeos-aimeos-headless/health.svg) ``` [![Health](https://phpackages.com/badges/aimeos-aimeos-headless/health.svg)](https://phpackages.com/packages/aimeos-aimeos-headless) ``` ### Alternatives [aimeos/aimeos Aimeos ecommerce and shop system 5.3k108.1k](/packages/aimeos-aimeos)[aimeos/aimeos-laravel Cloud native, API first Laravel eCommerce package with integrated AI for ultra-fast online shops, marketplaces and complex B2B projects 8.6k214.7k3](/packages/aimeos-aimeos-laravel)[openai-php/laravel OpenAI PHP for Laravel is a supercharged PHP API client that allows you to interact with the Open AI API 3.7k7.6M74](/packages/openai-php-laravel)[nickurt/laravel-postcodeapi Universal PostcodeApi for Laravel 11.x/12.x/13.x 97221.2k](/packages/nickurt-laravel-postcodeapi)[mozex/anthropic-laravel Anthropic PHP for Laravel is a supercharged PHP API client that allows you to interact with the Anthropic API 71226.4k1](/packages/mozex-anthropic-laravel)[specialtactics/laravel-api-boilerplate An API boilerplate for Laravel 5421.5k](/packages/specialtactics-laravel-api-boilerplate) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)