GraphQL Overview

GraphQL is a data query language developed internally by Facebook in 2012 before being publicly released in 2015. Magento implements GraphQL to provide an alternative to REST and SOAP web APIs for frontend development.

The current state of Magento GraphQL

As of Magento 2.4.0, GraphQL provides the following features:

  • Support for all product types, payment methods, and shipping methods
  • Redesigned a feature rich layered navigation
  • Reorders
  • Inventory Management store pickups

Where we’re going

The graphql-ce Community Engineering repository has been archived.

For the 2.4.1 and 2.4.2 releases, Magento and Community teams are working toward completing GraphQL coverage for Business to Consumer (B2C) uses cases, with emphasis on the following:

  • Order history for logged in customers
  • Replace product-specific mutations that add products to a cart with a single mutation that can handle all product types
  • Gift wrapping and messages
  • Product reviews
  • Wishlists
  • Reward points
  • Saved payment methods

We also expect to begin adding coverage for B2B scenarios.

How to access GraphQL

Use a GraphQL IDE such as GraphiQL or a browser extension to run the code samples and tutorials. If you install a browser extension, make sure it has the ability to set request headers. On Google Chrome, Altair GraphQL Client is one extension that can do the job.

To begin exploring GraphQL, set the GraphQL endpoint by entering http://<magento2-server>/graphql in the URL bar of your IDE or extension. You can use the browser in the right column to determine how to set up a query or mutation. Examples are also available throughout the Magento GraphQL documentation.

The following image shows a sample query, its response, and the GraphQL browser:

GraphiQL browser