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

Function: createGranularReplicationsClient()

createGranularReplicationsClient(config, auth): GranularReplicationsClient

Defined in: packages/b2c-tooling-sdk/src/clients/granular-replications.ts:79

Creates a Granular Replications API client for publishing individual items.

The Granular Replications API enables programmatic publishing of individual items (products, price tables, content assets) from staging to production environments.

Parameters

config

GranularReplicationsClientConfig

Client configuration with shortCode and tenantId

auth

AuthStrategy

OAuth authentication strategy

Returns

GranularReplicationsClient

Typed Granular Replications API client

Example

import {createGranularReplicationsClient, OAuthStrategy} from '@salesforce/b2c-tooling-sdk';

const auth = new OAuthStrategy({
  clientId: 'your-client-id',
  clientSecret: 'your-client-secret',
  tokenEndpoint: 'https://account.demandware.com/dwsso/oauth2/access_token'
});

const client = createGranularReplicationsClient({
  shortCode: 'kv7kzm78',
  tenantId: 'zzxy_prd'
}, auth);

// Queue a product for publishing
const result = await client.POST('/organizations/{organizationId}/granular-processes', {
  params: {path: {organizationId: 'f_ecom_zzxy_prd'}},
  body: {product: {productId: 'PROD-123'}}
});

// List all publish processes
const processes = await client.GET('/organizations/{organizationId}/granular-processes', {
  params: {
    path: {organizationId: 'f_ecom_zzxy_prd'},
    query: {limit: 20, offset: 0}
  }
});

See

https://developer.salesforce.com/docs/commerce/commerce-api/references/replications