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

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

# Interface: ScapiSchemasClientConfig

Defined in: [packages/b2c-tooling-sdk/src/clients/scapi-schemas.ts:101](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/scapi-schemas.ts#L101)

Configuration for creating a SCAPI Schemas client.

## Properties

### middlewareRegistry?

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

Defined in: [packages/b2c-tooling-sdk/src/clients/scapi-schemas.ts:126](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/scapi-schemas.ts#L126)

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/scapi-schemas.ts:120](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/scapi-schemas.ts#L120)

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

***

### shortCode

> **shortCode**: `string`

Defined in: [packages/b2c-tooling-sdk/src/clients/scapi-schemas.ts:107](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/scapi-schemas.ts#L107)

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/scapi-schemas.ts:114](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/scapi-schemas.ts#L114)

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"
```
