Crystallize logo
More in Learn

Catalogue API

The catalogue API provides an easy way to query the catalogue via GraphQL.

Accessing the API

The catalogue API is easily accessible on a per-tenant basis as a POST to https://api.crystallize.com/teddy-bear-shop/catalogue - replacing "teddy-bear-shop" with your own tenant identifier.

cURL Example

Below is an example of how you can fetch an item from the catalogue via cURL.

Circle loading spinnerImage of a partial circle indicating &qoute;loading&qoute;.Fetching snippet...

GraphQL Playground

The GraphQL Playground is an interactive UI where you can build and test queries you want to send to the catalogue API. You can access the GraphQL Playground by opening the API URL in your web browser. For our Teddy Bear Shop example, this would be https://api.crystallize.com/teddy-bear-shop/catalogue. You can replace the "teddy-bear-shop" 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 the structure of the response.

GraphQL Playground

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

People showing thumbs up

Need further help?

Join and ask our
slack community.

Join our slack community