Skip to content
  • Documentation >
  • Apps >
  • Website Building >
  • CraftQL

CraftQL

Getting Started with CraftQL

The CraftQL modules allow you to execute mutation query, simple query and GraphQL query against Craft CMS.

Prerequisites

In order to use CraftQL with Ibexa Connect, it is necessary to have a CraftQL plugin installed in your CraftCMS.

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!

Connecting CraftQL to Ibexa Connect

To connect your CraftQL plugin to Ibexa Connect create your token in the CraftQL settings and insert the token into the Ibexa Connect CraftQL module's Create a connection dialog.

Usage

Execute any GraphQL query against CraftQL.

Useful for getting out content.

Example Query

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
query getOrders {
   entries(type: [Order], orderStatus: confirmed) {
    id,
    ... on Order {
     delivery_address {
      name
      line1
      line2
      city
      zip
     },
     dateCreated
     status
     products {
      ... on products_line {
       qty: pl_qty,      
       price: pl_price,
       product: pl_product_rel {
        ... on Product {
           id
         title
         sku
        }
       }
      }
     }
     total
     totalQty
    }
   }
  }

Mutate

Executes a mutation query.

Insert parameters using the JSON** > **Create JSON module.