js-api-client

Crystallize JS API Client

The @crystallize/js-api-client package provides typed utilities for working with all Crystallize APIs in JavaScript/TypeScript environments.

Consultation Approach

Before writing code, understand the context. Ask clarifying questions:

1. What are you trying to do? Read data, write data, manage carts, handle webhooks?
2. Do you need raw GraphQL or a high-level helper? Helpers reduce boilerplate for common workflows (orders, carts, navigation). Use raw GraphQL via API callers for custom queries or when helpers don't cover the use case.
3. Which API? Catalogue/Discovery for storefront reads, PIM for admin writes, Shop Cart for checkout flows.
4. What auth do you have? staticAuthToken is enough for read-only. PIM/Shop operations need accessTokenId + accessTokenSecret.
5. Is this server-side or client-side? The client works in both, but credentials should only live server-side.

Installation

pnpm add @crystallize/js-api-client
# or npm install @crystallize/js-api-client
# or yarn add @crystallize/js-api-client

Quick Start

import { createClient } from "@crystallize/js-api-client";

const api = createClient({
    tenantIdentifier: "your-tenant",
    // For protected APIs, provide credentials:
    // accessTokenId: '…',
    // accessTokenSecret: '…',
    // staticAuthToken: '…', // for read-only catalogue/discovery
});

// Call any GraphQL API with string queries
const { catalogue } = await api.catalogueApi(
    `query Q($path: String!, $language: String!) {
    catalogue(path: $path, language: $language) {
      name
      path
    }
  }`,
    { path: "/shop", language: "en" },
);

// Close when using HTTP/2 option
api.close();

Configuration

createClient(configuration, options?)

Configuration Options

Option	Description
tenantIdentifier	Required. Your tenant name
tenantId	Optional tenant ID
accessTokenId / accessTokenSecret	For PIM/Shop operations
sessionId	Alternative to token-based auth
staticAuthToken	For read-only catalogue/discovery
shopApiToken	Auto-fetched if not provided
shopApiStaging	Use staging Shop API
origin	Custom host suffix (default: .crystallize.com)

Client Options

Option	Description
useHttp2	Enable HTTP/2 transport
profiling	Profiling callbacks for debugging
extraHeaders	Extra request headers for all calls
shopApiToken	Control auto-fetch behavior

API Callers

All callers share the same signature:

<T>(query: string, variables?: Record<string, unknown>) => Promise<T>;

Caller	Purpose
catalogueApi	Catalogue GraphQL
discoveryApi	Discovery GraphQL (search/browse)
pimApi	PIM GraphQL (legacy — prefer nextPimApi)
nextPimApi	PIM Next GraphQL (scoped to tenant, recommended)
shopCartApi	Shop Cart GraphQL (token auto-handled)

High-Level Helpers

Available helpers (see High-Level Helpers Reference for full examples):

Helper	Import	Purpose
createCatalogueFetcher	@crystallize/js-api-client	Build typed catalogue queries with object syntax
createNavigationFetcher	@crystallize/js-api-client	Fetch navigation trees by depth
createProductHydrater	@crystallize/js-api-client	Fetch products/variants by path or SKU
createOrderFetcher	@crystallize/js-api-client	Fetch orders with type-safe field selection
createOrderManager	@crystallize/js-api-client	Create/update orders, set payments, move pipeline stages
createCustomerManager	@crystallize/js-api-client	Create and update customers
createCustomerGroupManager	@crystallize/js-api-client	Manage customer groups
createSubscriptionContractManager	@crystallize/js-api-client	Create and manage subscription contracts
createCartManager	@crystallize/js-api-client	Hydrate carts, add items, place orders (token auto-handled)

Authentication

Auth Type	Use Case
staticAuthToken	Read-only catalogue/discovery
accessTokenId + accessTokenSecret	PIM/Shop operations
sessionId	Alternative to token pair
shopApiToken	Optional; auto-fetched if omitted

Generate access tokens in the Crystallize App: Settings → Access Tokens

References

• High-Level Helpers - Catalogue Fetcher, Navigation Fetcher, Product Hydrater, Order Manager, Customer Manager, Cart Manager, and more
• Utilities - GraphQL Builder, Signature Verification, Binary File Manager, Pricing Utilities, Request Profiling
• Official Documentation
• GitHub Repository
• NPM Package