PHPackages oxid-esales/graphql-storefront - 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. oxid-esales/graphql-storefront ActiveOxideshop-module[API Development](/categories/api) oxid-esales/graphql-storefront ============================== OXID eSales GraphQL storefront module v5.0.0(1mo ago)2055.3k↓51.4%81proprietaryPHPPHP ^8.3CI passing Since Dec 16Pushed 2w ago7 watchersCompare [ Source](https://github.com/OXID-eSales/graphql-storefront-module)[ Packagist](https://packagist.org/packages/oxid-esales/graphql-storefront)[ Docs](https://www.oxid-esales.com)[ RSS](/packages/oxid-esales-graphql-storefront/feed)WikiDiscussions b-7.6.x Synced 3d ago READMEChangelogDependencies (35)Versions (55)Used By (1) GraphQL Storefront ================== [](#graphql-storefront) [![Build Status](https://camo.githubusercontent.com/86a6d77157ab625ea5ed7418cf139d631f5e514f45a5e704be022b395d31ce65/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f776f726b666c6f772f7374617475732f4f5849442d6553616c65732f6772617068716c2d73746f726566726f6e742d6d6f64756c652f43493f6c6f676f3d6769746875622d616374696f6e73267374796c653d666f722d7468652d6261646765)](https://github.com/OXID-eSales/graphql-storefront-module/actions) [![Latest Version](https://camo.githubusercontent.com/1fb89172accf71af3d67e5e8896d75a5d6bbb5fc75823c0af8176b60a3836416/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f4f5849442d6553616c65732f6772617068716c2d73746f726566726f6e743f6c6f676f3d636f6d706f736572266c6162656c3d6c617465737426696e636c7564655f70726572656c656173657326636f6c6f723d6f72616e6765)](https://packagist.org/packages/oxid-esales/graphql-storefront)[![PHP Version](https://camo.githubusercontent.com/4a4245875771db22d5f22b0099b2c4353bdd141245f527a663ee4d4ba2bb7dea/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f6f7869642d6573616c65732f6772617068716c2d73746f726566726f6e74)](https://github.com/oxid-esales/graphql-storefront-module) [![Quality Gate Status](https://camo.githubusercontent.com/0dcaf6c354b637e0d95aa1cb4d1d859a84f96aae1581d80c37be56f1da7095d7/68747470733a2f2f736f6e6172636c6f75642e696f2f6170692f70726f6a6563745f6261646765732f6d6561737572653f70726f6a6563743d4f5849442d6553616c65735f6772617068716c2d73746f726566726f6e742d6d6f64756c65266d65747269633d616c6572745f737461747573)](https://sonarcloud.io/dashboard?id=OXID-eSales_graphql-storefront-module)[![Coverage](https://camo.githubusercontent.com/216e1c3a1740fd5610c2d95427b41b8d681521360a709263238e1c1fef16ca25/68747470733a2f2f736f6e6172636c6f75642e696f2f6170692f70726f6a6563745f6261646765732f6d6561737572653f70726f6a6563743d4f5849442d6553616c65735f6772617068716c2d73746f726566726f6e742d6d6f64756c65266d65747269633d636f766572616765)](https://sonarcloud.io/dashboard?id=OXID-eSales_graphql-storefront-module)[![Technical Debt](https://camo.githubusercontent.com/67a50404cf2afb4949e42a2fd287d0d3cb8a6bf2404620be6b1688a24835db11/68747470733a2f2f736f6e6172636c6f75642e696f2f6170692f70726f6a6563745f6261646765732f6d6561737572653f70726f6a6563743d4f5849442d6553616c65735f6772617068716c2d73746f726566726f6e742d6d6f64756c65266d65747269633d7371616c655f696e646578)](https://sonarcloud.io/dashboard?id=OXID-eSales_graphql-storefront-module) This module provides [GraphQL](https://www.graphql.org) queries and mutations for the [OXID eShop](https://www.oxid-esales.com/) storefront. Usage ----- [](#usage) This assumes you have OXID eShop (at least `oxid-esales/oxideshop_ce: v7.6.0` component, which is part of the `v7.6.0` compilation) up and running. Branch compatibility -------------------- [](#branch-compatibility) - b-7.6.x branch is compatible with OXID eShop compilation b-7.6.x (which uses `graphql-base` 14.x version resp. b-7.6.x branch) - 5.x versions (or b-7.5.x branch) are compatible with OXID eShop compilation b-7.5.x (which uses `graphql-base` 13.x version resp. b-7.5.x branch) - 4.2.x versions (or b-7.4.x branch) are compatible with OXID eShop compilation b-7.4.x (which uses `graphql-base` 12.x version resp.b-7.4.x branch) - 4.1.x version (or b-7.3.x branch) are compatible with OXID eShop compilation b-7.3.x (which uses `graphql-base` 11.x version resp.b-7.3.x branch) - 4.0.x versions (or b-7.2.x branch) are compatible with OXID eShop compilation b-7.2.x (which uses `graphql-base` 10.x version resp. b-7.2.x branch) - 3.1.x versions (or b-7.1.x branch) are compatible with OXID eShop compilation b-7.1.x (which uses `graphql-base` 9.x version resp. b-7.1.x branch) - 3.x versions (or b-7.0.x branch) are compatible with OXID eShop compilation b-7.0.x (which uses `graphql-base` 8.x version resp. b-7.0.x branch) - ^2.1 versions (b-6.5.x branch) are compatible with OXID eShop compilation b-6.5.x (which uses `graphql-base` 7.x version resp. b-6.5.x branch) - 2.0.x versions (b-6.4.x branch) are compatible with OXID eShop compilation b-6.4.x (which uses `graphql-base` 6.x version resp. b-6.4.x branch) - 1.x versions (b-6.3.x branch) are compatible with OXID eShop compilation 6.3.x (no PHP8 support) ### Install [](#install) Switch to the shop root directory (the file `composer.json` and the directories `source/` and `vendor/` are located there). ``` # Install desired version of oxid-esales/graphql-storefront module, in this case - latest released 5.x version $ composer require oxid-esales/graphql-storefront ^5.0.0 ``` If you didn't have the `oxid-esales/graphql-base` module installed, composer will do that for you. You should run migrations both after installing the module and after each module update: ``` $ vendor/bin/oe-eshop-doctrine_migration migrations:migrate oe_graphql_base $ vendor/bin/oe-eshop-doctrine_migration migrations:migrate oe_graphql_storefront ``` After installing the module, you need to activate it, either via OXID eShop admin or CLI. ``` $ vendor/bin/oe-console oe:module:activate oe_graphql_base $ vendor/bin/oe-console oe:module:activate oe_graphql_storefront ``` ### How to use [](#how-to-use) A good starting point is to check the [How to use section in the GraphQL Base Module](https://github.com/OXID-eSales/graphql-base-module/#how-to-use) Testing ------- [](#testing) ### Linting, syntax check, static analysis [](#linting-syntax-check-static-analysis) ``` $ composer update $ composer static ``` ### Unit/Integration/Acceptance tests [](#unitintegrationacceptance-tests) - install this module into a running OXID eShop - reset shop's database ``` $ bin/oe-console oe:database:reset --db-host=db-host --db-port=db-port --db-name=db-name --db-user=db-user --db-password=db-password --force ``` - run Unit tests ``` $ ./vendor/bin/phpunit -c vendor/oxid-esales/graphql-storefront/tests/phpunit.xml ``` - run Integration tests ``` $ ./vendor/bin/phpunit --bootstrap=./source/bootstrap.php -c vendor/oxid-esales/graphql-storefront/tests/phpintegration.xml ``` - run Acceptance tests ``` $ SELENIUM_SERVER_HOST=selenium MODULE_IDS=oe_graphql_storefront vendor/bin/codecept run acceptance -c vendor/oxid-esales/graphql-storefront/tests/codeception.yml ``` Development installation on OXID eShop SDK ========================================== [](#development-installation-on-oxid-eshop-sdk) The installation instructions below are shown for the current [SDK](https://github.com/OXID-eSales/docker-eshop-sdk)for shop 7.6. Make sure your system meets the requirements of the SDK. 1. Ensure all docker containers are down to avoid port conflicts 2. Clone the SDK for the new project ``` echo MyProject && git clone https://github.com/OXID-eSales/docker-eshop-sdk.git $_ && cd $_ ``` 2. Clone the repository to the source directory ``` git clone --recurse-submodules https://github.com/OXID-eSales/graphql-storefront-module.git --branch=b-7.6.x ./source ``` 3. Run the recipe to setup the development environment ``` ./source/recipes/setup-development.sh ``` You should be able to access the shop with and the admin panel with (credentials: / admin) ### Running tests locally [](#running-tests-locally) Check the "scripts" section in the `composer.json` file for the available commands. Those commands can be executed by connecting to the php container and running the command from there, example: ``` make php composer tests-coverage ``` Commands can be also triggered directly on the container with docker compose, example: ``` docker compose exec -T php composer tests-coverage ``` Contributing ------------ [](#contributing) You like to contribute? 🙌 AWESOME 🙌 Go and check the [contribution guidelines](CONTRIBUTING.md) Build with ---------- [](#build-with) - [GraphQLite](https://graphqlite.thecodingmachine.io/) License ------- [](#license) OXID Module and Component License, see [LICENSE file](LICENSE). ### Health Score 64 — FairBetter than 99% of packages Maintenance93 Actively maintained with recent releases Popularity41 Moderate usage in the ecosystem Community25 Small or concentrated contributor base Maturity82 Battle-tested with a long release history Bus Factor3 3 contributors hold 50%+ of commits 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 ~140 days Recently: every ~131 days Total 15 Last Release 58d ago Major Versions v0.1.0 → v1.0.0-rc12021-05-20 v1.0.0 → v2.0.02021-12-08 v2.1.0 → v3.0.02023-06-09 v3.1.0 → v4.0.0-rc.12024-11-04 v4.2.0 → v5.0.02026-05-07 PHP version history (6 changes)v0.1.0PHP ^7.1 v2.0.0PHP ^7.4 | ^8.0 v3.0.0PHP ^8.0 v3.1.0-rc.1PHP ^8.1 v4.0.0-rc.1PHP ^8.2 v5.0.0PHP ^8.3 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/1374817?v=4)[oxid](/maintainers/oxid)[@OxID](https://github.com/OxID) --- Top Contributors [![MarcelOxid](https://avatars.githubusercontent.com/u/98812941?v=4)](https://github.com/MarcelOxid "MarcelOxid (224 commits)")[![Sieg](https://avatars.githubusercontent.com/u/98882?v=4)](https://github.com/Sieg "Sieg (180 commits)")[![hkreuter](https://avatars.githubusercontent.com/u/3692295?v=4)](https://github.com/hkreuter "hkreuter (118 commits)")[![NikolaIvanovski](https://avatars.githubusercontent.com/u/8055347?v=4)](https://github.com/NikolaIvanovski "NikolaIvanovski (77 commits)")[![RahatHameed](https://avatars.githubusercontent.com/u/11661532?v=4)](https://github.com/RahatHameed "RahatHameed (70 commits)")[![TitaKoleva](https://avatars.githubusercontent.com/u/22682166?v=4)](https://github.com/TitaKoleva "TitaKoleva (59 commits)")[![realFlowControl](https://avatars.githubusercontent.com/u/14161194?v=4)](https://github.com/realFlowControl "realFlowControl (46 commits)")[![tkcreateit](https://avatars.githubusercontent.com/u/42207462?v=4)](https://github.com/tkcreateit "tkcreateit (34 commits)")[![skoczekj](https://avatars.githubusercontent.com/u/42207445?v=4)](https://github.com/skoczekj "skoczekj (24 commits)")[![angel-dimitrov](https://avatars.githubusercontent.com/u/12593227?v=4)](https://github.com/angel-dimitrov "angel-dimitrov (22 commits)")[![danbeck](https://avatars.githubusercontent.com/u/8845891?v=4)](https://github.com/danbeck "danbeck (8 commits)")[![michaelkeiluweit](https://avatars.githubusercontent.com/u/2961521?v=4)](https://github.com/michaelkeiluweit "michaelkeiluweit (2 commits)")[![makkus183](https://avatars.githubusercontent.com/u/2034761?v=4)](https://github.com/makkus183 "makkus183 (1 commits)")[![jaunas](https://avatars.githubusercontent.com/u/5628922?v=4)](https://github.com/jaunas "jaunas (1 commits)")[![zckman](https://avatars.githubusercontent.com/u/18466068?v=4)](https://github.com/zckman "zckman (1 commits)") --- Tags graphqlOXIDmoduleseshop ### Code Quality TestsPHPUnit Static AnalysisPHPStan Code StylePHP\_CodeSniffer Type Coverage Yes ### Embed Badge ![Health badge](/badges/oxid-esales-graphql-storefront/health.svg) ``` [![Health](https://phpackages.com/badges/oxid-esales-graphql-storefront/health.svg)](https://phpackages.com/packages/oxid-esales-graphql-storefront) ``` ### Alternatives [sylius/sylius E-Commerce platform for PHP, based on Symfony framework. 8.5k5.9M738](/packages/sylius-sylius)[oxid-esales/graphql-configuration-access OXID eSales GraphQL configuration access module 141.5k3](/packages/oxid-esales-graphql-configuration-access)[oxid-esales/oxideshop-ce This package contains OXID eShop CE source code. 2371.2M263](/packages/oxid-esales-oxideshop-ce)[oxid-esales/graphql-base OXID eSales GraphQL base module 24107.6k16](/packages/oxid-esales-graphql-base)[flat3/lodata OData v4.01 Producer for Laravel 99351.7k](/packages/flat3-lodata)[pagemachine/searchable TYPO3 extension to index and search content with Elasticsearch 1039.9k](/packages/pagemachine-searchable) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)