@salesforce/b2c-tooling-sdk / clients / createOcapiClient

Function: createOcapiClient()

createOcapiClient(hostname, auth, apiVersion): OcapiClient

Defined in: packages/b2c-tooling-sdk/src/clients/ocapi.ts:101

Creates a typed OCAPI Data API client.

Returns the openapi-fetch client directly, with authentication handled via middleware. This gives full access to all openapi-fetch features with type-safe paths, parameters, and responses.

Note: This client is typically accessed via B2CInstance.ocapi rather than created directly. The B2CInstance class handles authentication setup.

Parameters

hostname

string

B2C instance hostname

auth

AuthStrategy

Authentication strategy (typically OAuth)

apiVersion

string = DEFAULT_API_VERSION

API version (defaults to v25_6)

Returns

OcapiClient

Typed openapi-fetch client

Examples

// Via B2CInstance (recommended)
const instance = B2CInstance.fromEnvironment();
const { data, error } = await instance.ocapi.GET('/sites', {});

// Direct instantiation (advanced)
const client = createOcapiClient('sandbox.demandware.net', authStrategy);

// Fully typed GET request
const { data, error } = await client.GET('/sites', {
  params: { query: { select: '(**)' } }
});

// Path parameters are type-checked
const { data, error } = await client.GET('/sites/{site_id}', {
  params: { path: { site_id: 'RefArch' } }
});

// Request bodies are typed
const { data, error } = await client.PATCH('/code_versions/{code_version_id}', {
  params: { path: { code_version_id: 'v1' } },
  body: { active: true }
});