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

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

# Interface: CustomApisClientConfig

Defined in: [packages/b2c-tooling-sdk/src/clients/custom-apis.ts:79](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/custom-apis.ts#L79)

Configuration for creating a Custom APIs client.

## Properties

### middlewareRegistry?

> `optional` **middlewareRegistry**: [`MiddlewareRegistry`](../classes/MiddlewareRegistry.md)

Defined in: [packages/b2c-tooling-sdk/src/clients/custom-apis.ts:104](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/custom-apis.ts#L104)

Middleware registry to use for this client.
If not specified, uses the global middleware registry.

***

### scopes?

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

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

Optional scope override. If not provided, defaults to domain scope
(sfcc.custom-apis) plus tenant-specific scope (SALESFORCE_COMMERCE_API:{tenant}).

***

### shortCode

> **shortCode**: `string`

Defined in: [packages/b2c-tooling-sdk/src/clients/custom-apis.ts:85](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/custom-apis.ts#L85)

The short code for the SCAPI instance.
This is typically a 4-8 character alphanumeric code.

#### Example

```ts
"kv7kzm78"
```

***

### tenantId

> **tenantId**: `string`

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

The tenant ID (with or without f_ecom_ prefix).
Used to build the organizationId path parameter and tenant-specific OAuth scope.

#### Example

```ts
"zzxy_prd" or "f_ecom_zzxy_prd"
```