@salesforce/b2c-tooling-sdk / operations/mrt / GetRedirectBackendOptions
Interface: GetRedirectBackendOptions
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:1143
Options for getRedirectWithBackend.
Extends
Properties
environment
environment:
string
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:937
Target/environment slug (= SCAPI environment ID).
Inherited from
RedirectBackendOptions.environment
identifier
identifier:
string
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:1145
Redirect identifier: the from_path on legacy, the UUID on SCAPI.
legacyAuth?
optionallegacyAuth:AuthStrategy
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:933
Legacy API-key auth strategy. Optional; required only when the legacy backend actually runs.
Inherited from
RedirectBackendOptions.legacyAuth
onFallback()?
optionalonFallback: (reason) =>void
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:941
Invoked when auto falls back from SCAPI to legacy.
Parameters
reason
string
Returns
void
Inherited from
RedirectBackendOptions.onFallback
onResolve()?
optionalonResolve: (backend) =>void
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:943
Invoked with the backend that serves the call (for -D debug).
Parameters
backend
Returns
void
Inherited from
RedirectBackendOptions.onResolve
origin?
optionalorigin:string
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:939
Legacy MRT API origin.
Inherited from
preference
preference:
MrtBackendPreference
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:929
Resolved --mrt-backend preference.
Inherited from
RedirectBackendOptions.preference
projectSlug
projectSlug:
string
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:935
Project slug (= SCAPI storefront ID).
Inherited from
RedirectBackendOptions.projectSlug
scapiConnection?
optionalscapiConnection:ScapiMrtConnection
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:931
SCAPI connection; when absent, auto uses legacy and scapi throws.