B2C CLI

Appearance

@salesforce/b2c-tooling-sdk / clients

clients ​

API clients for B2C Commerce operations.

This module provides typed client classes for interacting with B2C Commerce APIs including WebDAV, OCAPI, SCAPI, and ODS.

Available Clients ​

  • WebDavClient - File operations via WebDAV
  • OcapiClient - Data API operations via OCAPI (openapi-fetch Client)
  • SlasClient - SLAS Admin API for managing tenants and clients
  • OdsClient - On-Demand Sandbox API for managing developer sandboxes

Usage ​

Note: These clients are typically accessed via B2CInstance rather than instantiated directly. The B2CInstance class handles authentication setup and provides convenient webdav and ocapi getters.

typescript
import { B2CInstance } from '@salesforce/b2c-tooling-sdk';

const instance = B2CInstance.fromEnvironment({
  clientSecret: process.env.SFCC_CLIENT_SECRET,
});

// WebDAV operations via instance.webdav
await instance.webdav.put('Cartridges/v1/app.zip', content);

// OCAPI operations via instance.ocapi (openapi-fetch)
const { data } = await instance.ocapi.GET('/sites', {});

Direct Client Usage ​

For advanced use cases, clients can be instantiated directly:

typescript
import { WebDavClient, createOcapiClient, createSlasClient } from '@salesforce/b2c-tooling-sdk/clients';

const webdav = new WebDavClient('sandbox.demandware.net', authStrategy);
const ocapi = createOcapiClient('sandbox.demandware.net', authStrategy);

// SLAS client for managing SLAS clients and tenants
const slas = createSlasClient({ shortCode: 'kv7kzm78' }, oauthStrategy);

Creating New API Clients ​

API clients follow a consistent pattern using openapi-fetch for type-safe HTTP requests and openapi-typescript for generating TypeScript types from OpenAPI specifications.

Step 1: Add the OpenAPI Specification ​

Place the OpenAPI spec (JSON or YAML) in specs/:

packages/b2c-tooling/specs/my-api-v1.yaml

Step 2: Generate TypeScript Types ​

Add a generation command to package.json and run it:

bash
openapi-typescript specs/my-api-v1.yaml -o src/clients/my-api.generated.ts

Step 3: Create the Client Module ​

Create a new client file following this pattern:

typescript
// src/clients/my-api.ts
import createClient, { type Client } from 'openapi-fetch';
import type { AuthStrategy } from '../auth/types.js';
import type { paths, components } from './my-api.generated.js';
import { createAuthMiddleware, createLoggingMiddleware } from './middleware.js';

export type { paths, components };
export type MyApiClient = Client<paths>;

export function createMyApiClient(config: MyApiConfig, auth: AuthStrategy): MyApiClient {
  const client = createClient<paths>({
    baseUrl: `https://${config.host}/api/v1`,
  });

  // Add middleware - auth first, logging last (so logging sees complete request)
  client.use(createAuthMiddleware(auth));
  client.use(createLoggingMiddleware('MYAPI'));

  return client;
}

Conventions ​

  • Factory function: Use createXxxClient() pattern (not classes)
  • Type exports: Re-export paths and components for consumers
  • Client type: Export a type alias XxxClient = Client<paths>
  • Middleware order: Logging first, then auth (auth runs last on request)
  • Log prefix: Use short, uppercase identifier (e.g., 'OCAPI', 'SLAS', 'SCAPI')
  • Generated files: Name as xxx.generated.ts to indicate auto-generation

Classes ​

Interfaces ​

Type Aliases ​

Variables ​

Functions ​

All rights reserved.

Copyright © 2025 Salesforce, Inc. All rights reserved.