Core API

The Core API can be accessed via the following endpoint:

https://api.crystallize.com/@your-tenant-identifier

Authentication is required to access the Core API. You can generate access tokens in order to do so.

The PIM API will be deprecated in favor of the Core API. However, we plan to support the PIM API for the foreseeable future.

While we're in the process of migrating functionality between the APIs, the PIM API cannot be fully replaced by the Core API just yet. However, certain queries and mutations are currently only available through the Core API, including:

• Direct component updates
• Path management
• Filtering orders by customer, meta, payment provider, SKU, etc.
• Creating pieces
• Archive-related mutations (creation, updating, deletion)
• Operations related to Flows

One major thing that differs within this API is error handling. You need to specifically query errors as follows:

{
  order(id: "ORDER_ID") { 
 		 ... on Order { 
 				 id 
 		 } 
 		 ...on OrderDoesNotBelongToTenantError { 
 				 errorName 
 				 message 
 		 } 
  } 
}

Queries can have errors that are specific to it, like in the example above, in addition to some common ones such as:

...on UnauthorizedError 
...on ExperimentalFeaturesNotAvailableError 
...on Unknown error 
...on BasicError

Have a look at our references for:

• Managing Flows
• Managing Orders
• Component Updates