Skip to content
View as Markdown
View as Markdown

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

Type Alias: ApiBackendPreference

ApiBackendPreference = "ocapi" | "scapi" | "auto"

Defined in: packages/b2c-tooling-sdk/src/clients/scapi-backend-utils.ts:25

User-facing API backend preference.

  • 'ocapi': force OCAPI (always use the legacy Data API).
  • 'scapi': force SCAPI (requires shortCode + tenantId; fails loudly if scopes missing).
  • 'auto': prefer SCAPI when configured, with temporary safe OCAPI fallback.

Released under the Apache-2.0 License.