@salesforce/b2c-tooling-sdk / instance

instance

B2C Instance management.

This module provides the B2CInstance class which represents a connection to a specific B2C Commerce instance. It combines instance configuration with authentication to provide typed API clients.

Usage

From environment configuration (recommended)

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

// Load from environment files (dw.json, etc.), override secrets from environment
const instance = B2CInstance.fromEnvironment({
  clientId: process.env.SFCC_CLIENT_ID,
  clientSecret: process.env.SFCC_CLIENT_SECRET,
});

// Use typed clients
await instance.webdav.put('Cartridges/v1/app.zip', content);
const { data } = await instance.ocapi.GET('/sites', {});

Direct construction

const instance = new B2CInstance(
  { hostname: 'your-sandbox.demandware.net', codeVersion: 'v1' },
  { oauth: { clientId: '...', clientSecret: '...' } }
);

Classes

• B2CInstance

Interfaces

• FromEnvironmentOptions
• InstanceConfig

References

AuthConfig

Re-exports AuthConfig

---

B2CInstanceOptions

Renames and re-exports FromEnvironmentOptions