---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../modules.md) / [clients](../index.md) / CommerceApiClientOptions

# Interface: CommerceApiClientOptions

Defined in: [packages/b2c-tooling-sdk/src/clients/am-provisioning.ts:92](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/clients/am-provisioning.ts#L92)

Options for [buildCommerceApiClientRequest](../functions/buildCommerceApiClientRequest.md) and [provisionCommerceApiClient](../functions/provisionCommerceApiClient.md).

## Properties

### active?

> `optional` **active**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/clients/am-provisioning.ts:111](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/clients/am-provisioning.ts#L111)

Create the client enabled. Default `true`.

***

### description?

> `optional` **description**: `string`

Defined in: [packages/b2c-tooling-sdk/src/clients/am-provisioning.ts:105](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/clients/am-provisioning.ts#L105)

Optional description shown in Account Manager.

***

### name

> **name**: `string`

Defined in: [packages/b2c-tooling-sdk/src/clients/am-provisioning.ts:94](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/clients/am-provisioning.ts#L94)

API client name shown in Account Manager.

***

### organizationId

> **organizationId**: `string`

Defined in: [packages/b2c-tooling-sdk/src/clients/am-provisioning.ts:96](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/clients/am-provisioning.ts#L96)

Account Manager organization ID the client belongs to.

***

### password?

> `optional` **password**: `string`

Defined in: [packages/b2c-tooling-sdk/src/clients/am-provisioning.ts:109](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/clients/am-provisioning.ts#L109)

Client password (secret). Default: [generateApiClientPassword](../functions/generateApiClientPassword.md).

***

### scopes

> **scopes**: readonly `string`[]

Defined in: [packages/b2c-tooling-sdk/src/clients/am-provisioning.ts:103](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/clients/am-provisioning.ts#L103)

OAuth scopes the client may request (e.g. `sfcc.products`, `sfcc.catalogs`).
They are also set as the client's default scopes.

***

### tenants

> **tenants**: readonly `string`[]

Defined in: [packages/b2c-tooling-sdk/src/clients/am-provisioning.ts:98](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/clients/am-provisioning.ts#L98)

Tenants the client may access through SCAPI (e.g. `zzzz_001` or `f_ecom_zzzz_001`).

***

### tokenEndpointAuthMethod?

> `optional` **tokenEndpointAuthMethod**: `"client_secret_post"` \| `"client_secret_basic"`

Defined in: [packages/b2c-tooling-sdk/src/clients/am-provisioning.ts:107](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/clients/am-provisioning.ts#L107)

How the client authenticates at the token endpoint. Default `client_secret_basic` (Account Manager does not support `client_secret_post`).
