Developer Preview — This project is in active development. APIs may change. Provide feedback
Skip to content

@salesforce/b2c-tooling-sdk / operations/mrt / getB2CTargetInfo

Function: getB2CTargetInfo()

getB2CTargetInfo(options, auth): Promise<{ }>

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/b2c-config.ts:205

Gets B2C Commerce info for a target/environment.

Returns the B2C Commerce instance and sites connected to the target.

Parameters

options

GetB2CTargetInfoOptions

Operation options

auth

AuthStrategy

Authentication strategy (ApiKeyStrategy)

Returns

Promise<{ }>

B2C target info

Throws

Error if request fails

Example

typescript
import { ApiKeyStrategy } from '@salesforce/b2c-tooling-sdk/auth';
import { getB2CTargetInfo } from '@salesforce/b2c-tooling-sdk/operations/mrt';

const auth = new ApiKeyStrategy(process.env.MRT_API_KEY!, 'Authorization');

const info = await getB2CTargetInfo({
  projectSlug: 'my-storefront',
  targetSlug: 'production'
}, auth);

console.log(`Instance: ${info.instance_id}`);
console.log(`Sites: ${info.sites?.join(', ')}`);

Released under the Apache-2.0 License.