Install and Setup

To start with GraphQL you need OXID eShop up and running (at least OXID-eSales/oxideshop_ce: v6.5.0 component, which is part of the 6.2.0 compilation).


Depending on your current shop version, you need to install a suitable version of the OXID GraphQL API. This installation manual is compatible with OXID eShop 6.5. For newer or older versions, please see the corresponding documentations.


First navigate to your shop’s root directory where the project composer.json file is located:

cd <shop_directory>

Then you can simply install the module(s) by using composer require command. In most cases you want the full GraphQL integration by OXID including the schema for the shop’s storefront. To achieve this you need to install the OXID GraphQL Storefront module:

composer require oxid-esales/graphql-storefront:~2.1.0

This will automatically install the OXID GraphQL Base module, which is needed for general GraphQL integration. In case you only need the basic GraphQL integration and want to implement your own queries and mutations, you can also install the GraphQL Base module exclusively:

composer require oxid-esales/graphql-base:^7.0


After the installation you need to run the migrations for the GraphQL Base module:

./vendor/bin/oe-eshop-doctrine_migration migrations:migrate oe_graphql_base

And if you decided to go with the GraphQL Storefront module, you must execute migrations for this one as well:

./vendor/bin/oe-eshop-doctrine_migration migrations:migrate oe_graphql_storefront


Now you need to activate the modules, either via OXID eShop administration area or the CLI:

./vendor/bin/oe-console oe:module:activate oe_graphql_base
./vendor/bin/oe-console oe:module:activate oe_graphql_storefront


Keep in mind that you have to activate the GraphQL Base module first.