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

Interface: CustomApisClientConfig

Defined in: packages/b2c-tooling-sdk/src/clients/custom-apis.ts:50

Configuration for creating a Custom APIs client.

Properties

middlewareRegistry?

optional middlewareRegistry: MiddlewareRegistry

Defined in: packages/b2c-tooling-sdk/src/clients/custom-apis.ts:75

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:69

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:56

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

Example

"kv7kzm78"

---

tenantId

tenantId: string

Defined in: packages/b2c-tooling-sdk/src/clients/custom-apis.ts:63

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

Example

"zzxy_prd" or "f_ecom_zzxy_prd"