Shopify's Admin API includes an API that uses GraphQL.
An easy way to try it is an IDE called GraphiQL (note that it is GraphiQL, not GraphQL), so this article explains how to use Shopify GraphiQL and its advantages and disadvantages.
What is GraphiQL?
It is an open source project operated by GraphQL.
You can interactively work with and execute GraphQL in your browser.
It is pronounced Graphical (/ˈɡrafək(ə)l/). (The same pronunciation as graphical.)
What is GraphQL?
GraphQL is a query language for APIs and a runtime for running queries on existing data. GraphQL provides a complete and easy-to-understand description of the data in your API, empowers clients to request only what they need, makes it easy to evolve your API over time, and enables powerful developer tools.
Quote: GraphQL | A query language for your API
How to use Shopify GraphiQL
Shopify GraphiQL can be used by simply installing the app on each store, but there is a demo on the Shopify Dev site, so let's try it out first!
https://shopify.dev/docs/apps/tools/graphiql-admin-apiLet's try a workshop!
Shopify provides a workshop called Learn how to call the GraphQL Admin API.
Although it is in English, I highly recommend it because it provides step-by-step instructions from installing the Shopify GraphiQL app to running a simple query!
Points to note about Shopify GraphiQL
There is one thing you need to be careful about when using Shopify GraphiQL.
It's about setting access privileges (scope) appropriately.
Shopify contains many types of data, and some data requires specific permissions to retrieve.
For example, product data has read and write permissions, and if you have read permission, you can view product data.
Using the Admin API allows you to retrieve and change various types of data in the store.
By granting appropriate permissions to the Shopify GraphiQL app, you can reduce the risk of deleting necessary data.
A safer approach is to avoid granting write permissions, grant only the necessary read permissions, and add permissions when needed.
Benefits of Shopify GraphiQL
Easily use the Shopify Admin API
As mentioned above, the biggest advantage of GraphiQL is that it is easy to try.
When using cURL or Postman, you need to obtain an access token.
Has powerful assistance features
It has autocomplete suggestions for objects and fields, which makes writing queries much easier.
You can also quickly reference documentation and format queries.
Disadvantages of Shopify GraphiQL
Not suitable for Shopify app development
As mentioned above, data in the Shopify Admin API has scopes that determine what can be accessed.
Some data can be retrieved from any app, while other data can only be accessed by the app that created it.
Because Shopify GraphiQL is used by installing an app, its access range is limited to the scopes that the Shopify GraphiQL app can access.
Therefore, data created by the Shopify app you are developing may not be accessible from GraphiQL.
When developing a Shopify app, it is more efficient to use something like Postman and access the Admin API with the access token of the app you are developing.
Please refer to this page for how to use Postman.
Run and manage Shopify Admin API queries with Postman
Sometimes the operation is a little unstable
There have been several times when the Shopify GraphiQL app crashed and became unusable.
(This may only occur with Partner accounts that manage multiple stores.)
If you uninstall and reinstall the app, you can use it again.
*This may have been fixed in the latest app.
Summary
This article explained how to use Shopify GraphiQL and its advantages and disadvantages.
It lets you use the Admin API easily, so please start by trying the demo or workshop.
