@salesforce/b2c-tooling-sdk / instance / InstanceConfig
Interface: InstanceConfig
Defined in: packages/b2c-tooling-sdk/src/instance/index.ts:92
Instance configuration (hostname, code version, etc.)
Properties
apiBackend?
optionalapiBackend:"ocapi"|"scapi"|"auto"
Defined in: packages/b2c-tooling-sdk/src/instance/index.ts:116
Backend preference for operations that support both OCAPI (legacy) and SCAPI. Defaults to 'auto' when unset. Lets the instance answer "should this operation prefer SCAPI?" without the caller re-reading config.
codeVersion?
optionalcodeVersion:string
Defined in: packages/b2c-tooling-sdk/src/instance/index.ts:96
Code version for deployments
hostname
hostname:
string
Defined in: packages/b2c-tooling-sdk/src/instance/index.ts:94
B2C instance hostname
shortCode?
optionalshortCode:string
Defined in: packages/b2c-tooling-sdk/src/instance/index.ts:105
SCAPI short code (e.g. kv7kzm78). Required, together with tenantId, to reach the Salesforce Commerce API. Populated from resolved configuration.
tenantId?
optionaltenantId:string
Defined in: packages/b2c-tooling-sdk/src/instance/index.ts:110
SCAPI tenant/organization ID (e.g. zzxy_prd). Required, together with shortCode, to reach the Salesforce Commerce API.
tlsOptions?
optionaltlsOptions:TlsOptions
Defined in: packages/b2c-tooling-sdk/src/instance/index.ts:100
TLS options for mTLS/self-signed certificate support
webdavHostname?
optionalwebdavHostname:string
Defined in: packages/b2c-tooling-sdk/src/instance/index.ts:98
Separate hostname for WebDAV (if different from main hostname)