Skip to main content
More in Learn

GraphQL Playground

The GraphQL playground is an interactive UI where you can build and test queries you want to send to the Crystallize GraphQL APIs. You can access the GraphQL playground for a given API by opening the appropriate API endpoint URL in your web browser. (Authentication may be required.)

How is this different from GraphiQL?

If you’re familiar with the GraphQL world, you may know about GraphiQL. It’s no problem if you prefer GraphiQL to test your GraphQL queries. The Crystallize GraphQL playground uses components of GraphiQL under the hood, but with additional features:

  • Query history.
  • Different themes.
  • Automatic schema reloading.
  • Support for GraphQL subscriptions.
  • Configuration of HTTP headers.
  • Interactive, multi-column schema documentation.

GraphQL playgound overview

The endpoint URLs for the Crystallize APIs are as follows:

  • Catalogue API: https://api.crystallize.com/{your-tenant-name}/catalogue
  • Order API: https://api.crystallize.com/{your-tenant-name}/orders (Authentication required by default. Refer to the Order API main page.)
  • PIM API: https://pim.crystallize.com/graphql
  • Search API: https://api.crystallize.com/{your-tenant-name}/search
  • Subscription API: https://api.crystallize.com/{your-tenant-name}/subscriptions (Authentication required by default. Refer to the Subscription API main page.)

Here’s an example of the Catalogue API playground for our demo furniture tenant: https://api.crystallize.com/furniture/catalogue You can replace the “furniture“ identifier with your own tenant identifier.

The image below shows how you can easily write your GraphQL query in the playground. Clicking on the play button in the middle of the screen allows you to see the structure of the response.

GraphQL playground query example Crystallize catalogue API

Opening the "Docs" sidebar on the right-hand side gives an overview of all the available functionality within the API, the arguments you can provide, and the structure of the returned data. You can refer to this sidebar for an up-to-date reference of all the data fields and types belonging to an object.


GraphQL playground catalogue API docs
People showing thumbs up

Need further assistance?

Ask the Crystallize team or other enthusiasts in our slack community.

Join our slack community