Administrate the storefront

Important

To administrate your storefront you need the GraphQL Storefront Administration module installed and activated. To use the queries and mutations of this module, admin rights are needed. This means that the user has to be assigned to the oxidadmin-group.

Important

The GraphQL Storefront Administration module is currently still under development. We already have a prototype version which can be tried out. If you are interested in working with this module, please contact us.

What can be done?

With the Storefront Administration module we are able to create products, change shop settings or administrate users.

Products

The following queries/mutations exists to administrate products:

Creation:

call to adminProductCreate mutation

 mutation productCreate {
     adminProductCreate(
         adminProductInput: {
             id: "coolId"
             languageInputs: [
                 {
                     locale: "en"
                     title: "ProductName"
                 }
             ]
         }
     ) {
         id
         active
     }
 }

As a result of the creation we get back the AdminProductDataTypeInterface, which contains all of the interesting information about the new product. By default isActive` and isHidden will be set to false. If no id was passed, an unique id will be generated and set.

Deletion:

call to adminProductDelete mutation

 mutation productDelete {
     adminProductDelete(
         productId: "productId"
     )
 }

If the deletion was successful, true will be returned.

Modification:

call to adminProductModify mutation

 mutation productModify {
     adminProductModify(
         adminProductInput: {
             id: "productId"
         }
     ) {
         id
         active
     }
 }

To modify a product, the id of the product has to be passed. If a field was not set, it won’t be updated. As a result, the AdminProductDataType is returned.

Import:

call to adminProductsImport mutation

 mutation productImport {
     adminProductsImport(
         adminProductInputs: [
             {
                 id: "productId-1"
             },
             {
                 id: "productId-2"
             }
         ]
     ) {
         id
         active
     }
 }

The import works the same like the creation of a product. The only difference is, that multiple products can be created at once. If the import fails at a specific point, a message will be shown with data like id and title and the thrown error, to make it possible to identify the failed product and the problem. The result is a list of all imported products as AdminProductDataType.

Query an Admin-Product:

call to adminProduct query

 query product {
     adminProduct(
         productId: "productId"
     ) {
         id
         active
     }
 }

This query is only returning a single product. To get the product as AdminProductDataType only the productId is needed.