Crystallize API Overview
Crystallize is a fully native headless service. Every feature is exposed through public APIs. The Crystallize App uses the same APIs that you do. There is no private back end. You get the full power of a truly native headless platform.
Product Universe APIs
APIs in this group power your storefront content. They are built for speed and flexibility with real time access to product data. Both APIs are read only and optimized for high performance.
Discovery API
A semantic API that combines browsing and search in one place. It supports full text search, filtering, faceting, and pagination. It follows the naming in your Product Universe. Shapes, components, price variants, stock locations. Use this for most storefront queries.
- Best for. Product landing pages, category pages, product search, filters, SEO listing pages, fast navigation.
- Strengths. One query model for browse and search. High performance. Semantic schema that mirrors your domain language.
- Async updates. Asynchronously updated from your published data. The typical delay is under one second. Large imports can take longer to surface in the Discovery API.
Catalogue API
The original API for reading Product Universe data by path.
- Best for. Deterministic exports. Cases where the payload must reflect the exact current state at read time.
- Strengths. Simple path based reads. Strong consistency with the source of truth.
- Limitations. No search, filtering, or faceting.
Commerce Engine API
Everything from cart to checkout to order placement.
Shop API
A fast, edge distributed API that handles carts and checkout. Read and write at the edge with asynchronous updates to the Core.
- Best for. Low latency cart operations. Promotions and totals calculations during checkout. Order creation.
- Strengths. Edge execution for speed. Designed for high write throughput during peak traffic.
- Sync model. Writes apply at the edge and sync to Core shortly after.
Core API
The Core API powers most capabilities in the Crystallize App. It is a read and write API.
- Typical uses. Managing shapes, items, customers, orders, price lists, stock locations, and configuration.
- Migration note. A legacy PIM API exists. Features are being migrated to the Core API. Prefer Core for new work.
Webhooks
Subscribe to events from Crystallize to integrate with other systems.
- Common triggers. Order created. Customer created. Item published. Flow stage changed.
- Typical uses. Push new orders to WMS and ERP. Sync customers to a CRM. Purge or refresh storefront cache after publish.
Keep exploring
Discovery API documentation
The Discovery API is the API which is designed to power your storefront with product information and marketing content. It is a read only API that is distributed and designed for read performance. You can browse, search, filter, facet and sort your data from Crystallize via the Discovery API.
It is designed to replace the catalogue API and search API (to be deprecated) as one API for fetching data from your Crystallize tenant. Discovery is a semantic API which means that the API signature follows the structure of your shapes and the components on your shape.
Catalogue API
The Catalogue API provides an efficient way to query the catalogue in Crystallize via GraphQL. Using this API, you can easily access any item present in your tenant, including all the products, documents, and folders.
Shop API
The cart is where you manage the checkout process for your customers. It holds products, quantities, and customer information before an order is placed.
Working With Webhooks
Webhooks let Crystallize notify your systems in real time when events happen in your tenant. Instead of polling APIs, you can react instantly to changes such as new orders, content updates, or state transitions in Flows.