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

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

Type Alias: MrtB2CClient

MrtB2CClient = Client<paths>

Defined in: packages/b2c-tooling-sdk/src/clients/mrt-b2c.ts:54

The typed MRT B2C client for B2C Commerce integration with Managed Runtime.

Common Endpoints

MethodPathDescription
GET/b2c-organization-info/{organization_slug}/Get B2C org info
GET/projects/{project_slug}/b2c-target-info/{target_slug}/Get B2C target info
PUT/projects/{project_slug}/b2c-target-info/{target_slug}/Update B2C target
PATCH/projects/{project_slug}/b2c-target-info/{target_slug}/Partial update target

Example

typescript
import { createMrtB2CClient } from '@salesforce/b2c-tooling-sdk/clients';
import { ApiKeyStrategy } from '@salesforce/b2c-tooling-sdk/auth';

const auth = new ApiKeyStrategy(apiKey, 'Authorization');
const client = createMrtB2CClient({}, auth);

// Get B2C target info
const { data, error } = await client.GET('/projects/{project_slug}/b2c-target-info/{target_slug}/', {
  params: { path: { project_slug: 'my-project', target_slug: 'staging' } }
});

See

Released under the Apache-2.0 License.