Skip to content
View as Markdown
View as Markdown

@salesforce/b2c-tooling-sdk / instance / ScapiClientConfig

Interface: ScapiClientConfig

Defined in: packages/b2c-tooling-sdk/src/instance/index.ts:66

SCAPI connection coordinates plus an auth strategy able to request the sfcc.* scopes each Commerce API operation needs.

Returned by B2CInstance.scapiClientConfig when — and only when — the instance carries both a shortCode and tenantId and is configured with a stateless OAuth flow (client-credentials or JWT Bearer) that can go back to Account Manager per request for arbitrary scopes. This is the single handle every SCAPI client factory consumes, so SCAPI operations need nothing beyond a B2CInstance.

Properties

auth

auth: AuthStrategy

Defined in: packages/b2c-tooling-sdk/src/instance/index.ts:69


shortCode

shortCode: string

Defined in: packages/b2c-tooling-sdk/src/instance/index.ts:67


tenantId

tenantId: string

Defined in: packages/b2c-tooling-sdk/src/instance/index.ts:68

Released under the Apache-2.0 License.