@salesforce/b2c-tooling-sdk / clients / provisionCommerceApiClient
Function: provisionCommerceApiClient()
provisionCommerceApiClient(
client,options):Promise<ProvisionedCommerceApiClient>
Defined in: packages/b2c-tooling-sdk/src/clients/am-provisioning.ts:181
Create an Account Manager API client for Commerce API (SCAPI Admin) access, scoped to the given tenants, and return its ID and secret.
The caller needs the Account Administrator or API Administrator role (see isAccountManagerApiClientAdmin), but Account Manager's response is authoritative. A newly created client can take a short time before its credentials work.
Parameters
client
AccountManagerApiClientsClient
options
Returns
Promise<ProvisionedCommerceApiClient>
Throws
NotPermittedError when Account Manager refuses the request (401/403)
Example
typescript
import {createAccountManagerApiClientsClient, provisionCommerceApiClient} from '@salesforce/b2c-tooling-sdk/clients';
const apiClients = createAccountManagerApiClientsClient({hostname}, userAuth);
const {clientId, clientSecret} = await provisionCommerceApiClient(apiClients, {
name: 'My App – jane@example.com – 2026-11-06',
organizationId,
tenants: ['zzzz_001'],
scopes: ['sfcc.products', 'sfcc.catalogs'],
});