> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vortexiq.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# API Version Status (OCAPI / SCAPI), Salesforce Commerce Cloud

> API Version Status (OCAPI / SCAPI), the per-integration API surface, version, and days-until-EOL for your realm. How to read it, why it matters, and how to act on it.

**Card class:** [Hero](/nerve-centre/overview#card-classes-explained)  •  **Category:** [Ecommerce Platform](/nerve-centre/connectors#connectors-by-type)

> Per-integration API version plus days-until-EOL. Salesforce deprecates two OCAPI versions a year, this card surfaces replatform-readiness signals before they bite.

## At a glance

> A live table of every Salesforce Commerce Cloud (SFCC, formerly Demandware) integration Vortex IQ talks to, the API surface it runs on (OCAPI or SCAPI), the version string in use, and how many days remain until Salesforce ends support for that version. SFCC integrations do not degrade gracefully at end-of-life, they break hard, so this card is an early-warning surface, not a vanity metric.

|                           |                                                                                                                                                                                                                                                                                                                       |
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **What it counts**        | One row per connected integration / API consumer against your realm. Each row shows the API family (OCAPI or SCAPI), the version it calls, and a computed days-until-EOL against Salesforce's published deprecation schedule.                                                                                         |
| **Why it matters**        | Salesforce deprecates roughly two OCAPI versions per year on a published timetable. When a version reaches end-of-life, calls against it stop working, not slow down, stop. A storefront or downstream integration pinned to an EOL version goes dark. This card gives you the runway to migrate before that happens. |
| **Reading the value**     | Read it as a readiness board. Green-ish rows have long runways; rows with a small or negative days-until-EOL number are the action items. A negative number means the version is already past EOL and is running on borrowed time.                                                                                    |
| **OCAPI vs SCAPI**        | OCAPI (Open Commerce API) is the legacy REST surface on a version-deprecation treadmill. SCAPI (Salesforce Commerce API) is the modern long-term surface Salesforce now positions as the strategic path. An integration still on OCAPI is a candidate for an SCAPI migration.                                         |
| **Version strings**       | SFCC OCAPI versions follow a `vNN.x` style cadence tied to release seasons. The exact string is read from the integration config, this card does not guess it.                                                                                                                                                        |
| **What "EOL" means here** | The date Salesforce stops serving that API version. Distinct from "deprecated" (announced but still working). This card computes runway to the hard cutoff.                                                                                                                                                           |
| **Unit**                  | number (days-until-EOL per row)                                                                                                                                                                                                                                                                                       |
| **Time window**           | Real-time (`RT`), reflects the current configured version on each integration                                                                                                                                                                                                                                         |
| **Alert trigger**         | any integration on a version with EOL `<60` days, surfaced via `sentiment_key: scc_api_version_status`                                                                                                                                                                                                                |
| **Sentiment key**         | `scc_api_version_status`                                                                                                                                                                                                                                                                                              |
| **Roles**                 | owner, engineering                                                                                                                                                                                                                                                                                                    |

## Calculation

Calculated automatically from your Salesforce Commerce Cloud data. See the At a glance summary above for what the metric tracks and the worked example below for a typical reading.

## Worked example

An enterprise retailer running a single SFCC B2C realm with four storefront sites, a headless PWA Kit sub-brand, and three back-office integrations. The snapshot is taken on 12 Mar 26 against Salesforce's published deprecation calendar.

| Integration                         | API surface | Version | EOL date       | Days until EOL |
| ----------------------------------- | ----------- | ------- | -------------- | -------------- |
| Legacy ISML storefront (RefArch-US) | OCAPI       | v21.x   | 30 Apr 26      | 49             |
| Legacy ISML storefront (RefArch-UK) | OCAPI       | v21.x   | 30 Apr 26      | 49             |
| OMS order export job                | OCAPI       | v22.x   | 15 Oct 26      | 217            |
| Marketing Cloud connector           | OCAPI       | v23.x   | 20 Mar 27      | 373            |
| Headless sub-brand (PWA Kit)        | SCAPI       | current | none scheduled | n/a            |
| Inventory sync (3PL)                | OCAPI       | v20.x   | 10 Feb 26      | -31            |

Three things to notice:

1. **Two storefront integrations are inside the 60-day alert window.** Both RefArch-US and RefArch-UK run OCAPI v21.x with 49 days of runway. That fires the `<60` day alert. Because they power live storefronts, an EOL here is a revenue-down event, not a back-office inconvenience. These are the top of the migration backlog.
2. **The 3PL inventory sync is already past EOL (-31 days).** A negative number means the version is technically retired. It may still be limping along on a grace period, but it is on borrowed time and can stop without further warning. This is the single most urgent row even though it is "just" an inventory job, because stale stock data drives oversells.
3. **The headless sub-brand on SCAPI has no scheduled EOL.** SCAPI is the modern long-term surface, so it does not sit on the OCAPI version treadmill. This row is your reference point for what "good" looks like and the destination for the OCAPI migrations above.
4. **The OMS and Marketing Cloud connectors have comfortable runway (217 and 373 days).** They are not alerting, but they belong on a planning Gantt chart now so the next deprecation does not become another fire drill. Pair this card with [Integrations on EOL'd / EOL-Soon Versions](/nerve-centre/kpi-cards/salesforce-commerce-cloud/integrations-on-eold-eol-soon-versions) for the rolled-up count.

## Sibling cards merchants should reference together

| Card                                                                                                                                                                 | Why pair it with API Version Status                                                                                                |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| [Integrations on EOL'd / EOL-Soon Versions](/nerve-centre/kpi-cards/salesforce-commerce-cloud/integrations-on-eold-eol-soon-versions)                                | The single-number rollup of this table. This card is the detail; that card is the headline count for an exec dashboard.            |
| [OCAPI vs SCAPI Usage Mix](/nerve-centre/kpi-cards/salesforce-commerce-cloud/ocapi-vs-scapi-usage-mix)                                                               | Shows the strategic direction of travel. Lots of OCAPI rows here plus a low SCAPI mix means a migration programme has not started. |
| [OCAPI / SCAPI Failure Rate Spike or Version EOL Imminent](/nerve-centre/kpi-cards/salesforce-commerce-cloud/ocapi-scapi-failure-rate-spike-or-version-eol-imminent) | The acute alert layer. When a version here crosses EOL or starts erroring, that card is what pages the on-call.                    |
| [Orders Awaiting Downstream Sync >24h](/nerve-centre/kpi-cards/salesforce-commerce-cloud/orders-awaiting-downstream-sync-24h)                                        | The first symptom of a broken integration is often sync drift. If an OMS connector here hits EOL, that card spikes.                |
| [Revenue at Risk (live)](/nerve-centre/kpi-cards/salesforce-commerce-cloud/revenue-at-risk-live)                                                                     | Quantifies the business exposure when a storefront-facing integration is about to break.                                           |

## Reconciling against Salesforce Commerce Cloud

**Where to look in Business Manager:**

SFCC's admin tool is **Business Manager**, accessed at a per-realm URL like `https://<realm>.business.demandware.net`. The version a cartridge or integration actually calls is not surfaced in a single Business Manager report, it lives in two places: **Administration, Site Development, Open Commerce API Settings** (the OCAPI client permission JSON, which pins the API version in the request path) and the **Account Manager** API client configuration for SCAPI consumers.

To verify a row in this card:

* **OCAPI version**: open **Administration, Site Development, Open Commerce API Settings** and read the `version` field in the Shop / Data API client config. The version string in the URL path (e.g. `/s/-/dw/shop/v21_x/...`) is the authoritative source.
* **SCAPI consumers**: SCAPI versioning is handled through Account Manager API clients and the SCAPI shopper/admin endpoints; there is no single Business Manager screen that lists every consumer, so this card's rollup is genuinely additive over what Business Manager shows.
* **Deprecation dates**: Salesforce publishes the OCAPI deprecation schedule in the B2C Commerce release notes and Help portal. Cross-check the EOL date in this card against the current published schedule.

**Why our number may legitimately differ from Business Manager:**

| Reason                                                                                                                                                                                       | Direction of divergence                                            |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
| **Multiple API clients per integration**. One logical integration can hold several OCAPI client configs at different versions; this card reports the version actually used on the read path. | Card may show fewer or different versions than the raw client list |
| **Published schedule changes**. Salesforce occasionally extends or moves an EOL date. The card recomputes against the latest published calendar; a stale BM screenshot will not.             | Card more current than a saved screenshot                          |
| **SCAPI not enumerated in BM**. SCAPI consumers are managed in Account Manager, not Business Manager, so BM alone undercounts your true API surface.                                         | Card higher / more complete than BM OCAPI settings                 |
| **Sandbox vs production realms**. Versions can differ between staging and production. Ensure you are comparing the same realm.                                                               | Either, depends on realm selection                                 |

## Known limitations / merchant FAQs

**What exactly happens when an OCAPI version reaches end-of-life?**
Calls against that version stop being served. It is a hard cutoff, not a slow degradation. Any integration pinned to that version, a storefront, an OMS export, an inventory sync, simply starts failing. This is why the card frames everything as days-of-runway and alerts at 60 days, the lead time you realistically need to test and ship a version bump.

**Why is SCAPI shown without an EOL date?**
SCAPI (Salesforce Commerce API) is Salesforce's modern, long-term API surface and is not on the same fixed version-deprecation treadmill as OCAPI. Individual SCAPI endpoints can still change, but the platform-level "two deprecations a year" cadence that makes OCAPI risky does not apply the same way. A row on SCAPI is generally the healthy end state.

**The card shows a negative days-until-EOL. Is that integration broken?**
A negative number means the version is already past its published EOL. In practice Salesforce sometimes serves a short grace period, so it may still be limping along, but it is unsupported and can stop at any time. Treat any negative row as the highest-priority migration item regardless of what it powers.

**How does Vortex IQ know the EOL dates?**
The card computes runway against Salesforce's published OCAPI deprecation schedule, which Salesforce maintains in the B2C Commerce release notes and Help portal. We do not invent dates. If Salesforce moves a date, the card reflects the latest published value on its next refresh.

**We run many integrations. Why do some not appear as separate rows?**
The card reports one row per distinct API consumer Vortex IQ can observe against your realm. Integrations that share a single API client config can collapse into one row. If you expect an integration to appear and it does not, check whether it shares a client with another consumer, or whether it talks to SFCC through a middleware layer that masks its version.

**Is this real-time?**
Yes. The card reflects the version currently configured on each integration, with the runway recomputed against today's date. There is no period window to choose, it is always "as of now". That is why the time window is shown as `RT`.

**Should I migrate everything to SCAPI immediately?**
Not blindly. Prioritise by runway and blast radius: anything inside the 60-day alert window, anything storefront-facing, and anything already negative goes first. Long-runway back-office jobs can be scheduled into a normal release cadence. Use [OCAPI vs SCAPI Usage Mix](/nerve-centre/kpi-cards/salesforce-commerce-cloud/ocapi-vs-scapi-usage-mix) to plan the overall programme.

***

### Tracked live in Vortex IQ Nerve Centre

*API Version Status (OCAPI / SCAPI)* is one of hundreds of KPI pulses Vortex IQ tracks across Salesforce Commerce Cloud and 70+ other ecommerce connectors. Nerve Centre runs the detection layer; Vortex Mind investigates the cause when something moves; Ask Viq lets you interrogate any number in plain English.

[Start for free](https://app.vortexiq.ai/login) or [book a demo](https://www.vortexiq.ai/contact-us) to see this metric running on your own data.
