The percentage split between legacy OCAPI and modern SCAPI in your call volume. It drives the strategic conversation with Salesforce, SCAPI is the future, and this number says how far along you are.
At a glance
A donut showing what share of your Salesforce Commerce Cloud (SFCC, formerly Demandware) API traffic runs on legacy OCAPI (Open Commerce API) versus modern SCAPI (Salesforce Commerce API). It is a strategic, not operational, metric. OCAPI sits on a version-deprecation treadmill that Salesforce winds down roughly twice a year; SCAPI is the long-term surface Salesforce now positions everyone toward. A high OCAPI share is a leading indicator of future migration work and technical risk; a rising SCAPI share is the sign a modernisation programme is landing.
| What it counts | The proportion of observed API call volume split between OCAPI and SCAPI. The donut renders the two slices as percentages of total tracked calls. |
| Why it matters | SCAPI is Salesforce’s strategic direction. The more of your traffic still runs on OCAPI, the more migration work and EOL exposure you carry. This card frames the “where are we on the SCAPI journey” conversation for both internal planning and Salesforce account reviews. |
| Reading the value | Read the OCAPI slice as the size of your modernisation backlog. 100% OCAPI means no SCAPI migration has started. A growing SCAPI slice over time is the proof a migration programme is making progress. There is no single “right” mix, the trend matters more than the snapshot. |
| OCAPI | The legacy REST surface. Reliable, widely deployed, but on a fixed deprecation cadence. Every OCAPI call is on a version that will eventually EOL. |
| SCAPI | The modern, long-term API surface for headless and modern storefront use (e.g. PWA Kit). Not on OCAPI’s fixed retirement treadmill. The strategic destination. |
| Strategic use | Best read as a trend line in quarterly business reviews. A flat 100% OCAPI quarter over quarter is a flag that modernisation has stalled. |
| Unit | number (percentage split across two slices) |
| Time window | Real-time (RT), the current observed call mix |
| Alert trigger | none configured |
| Sentiment key | scc_ocapi_vs_scapi_mix |
| 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 mid-way through a headless re-platform. The legacy ISML storefronts still run on OCAPI; a new sub-brand and the mobile app have moved to SCAPI. Snapshot taken 12 Mar 26 over a rolling traffic window.| API surface | Consumers on it | Share of call volume |
|---|---|---|
| OCAPI | Legacy ISML storefronts (US, UK, DE, JP), OMS export, inventory sync | 72% |
| SCAPI | Headless sub-brand (PWA Kit), native mobile app | 28% |
| OCAPI vs SCAPI Usage Mix (card) | 72% / 28% |
- 72% OCAPI is a large but unsurprising backlog for a mid-migration realm. Most enterprise SFCC implementations started life on OCAPI, so a majority share is the norm until the legacy storefronts move. The number is not a red flag on its own, the question is whether the SCAPI slice is growing quarter over quarter.
- The 28% SCAPI slice maps cleanly to the modernised properties. The headless sub-brand and mobile app are the parts that were built modern, and they account for exactly the SCAPI share. That coherence is reassuring: the mix reflects real architecture, not noise. The next big jump in SCAPI share will come when a legacy storefront re-platforms.
- The OCAPI 72% is also your EOL exposure surface. Every percentage point of OCAPI is traffic on a version that will eventually retire. Read this card alongside API Version Status and Integrations on EOL’d / EOL-Soon Versions to connect the strategic mix to concrete deadline risk.
- There is no alert here by design. A particular mix is not “wrong”, so the card does not page anyone. It is a planning and review artefact. The acute alerting lives on the version-status and failure-rate cards; this one informs the roadmap.
Sibling cards merchants should reference together
| Card | Why pair it with OCAPI vs SCAPI Usage Mix |
|---|---|
| API Version Status (OCAPI / SCAPI) | Turns the strategic OCAPI share into concrete per-integration EOL deadlines. The “so what” behind a high OCAPI slice. |
| Integrations on EOL’d / EOL-Soon Versions | A high OCAPI mix is the leading indicator of a future-rising count on this card. |
| OCAPI / SCAPI Failure Rate Spike or Version EOL Imminent | The acute alarm layer. This usage-mix card is the strategy; that card is the smoke detector. |
| Orders Awaiting Downstream Sync >24h | Legacy OCAPI integrations are the usual cause of sync drift when a version retires. |
| Revenue at Risk (live) | Quantifies the exposure carried by the OCAPI share when a deprecation lands. |
Reconciling against Salesforce Commerce Cloud
Where to look in Business Manager: SFCC’s admin tool is Business Manager, at a per-realm URL likehttps://<realm>.business.demandware.net. Business Manager does not present a single “OCAPI vs SCAPI traffic split” report, this card is genuinely additive. The closest pieces you can inspect by hand are:
- Administration, Site Development, Open Commerce API Settings: lists the OCAPI client configurations and their versions, telling you which integrations are on OCAPI, but not their share of live traffic.
- Account Manager (separate from Business Manager): where SCAPI API clients are registered. SCAPI consumers are managed here, not in Business Manager.
- Realm-level API usage and quota dashboards (where available to your role) can show call volume, but reconstructing the exact OCAPI/SCAPI percentage by hand is laborious.
| Reason | Direction of divergence |
|---|---|
| By call volume vs by integration count. This card splits by observed call volume; counting integrations on each surface gives a different ratio because one high-traffic storefront dwarfs a low-traffic job. | Often materially different |
| SCAPI managed outside Business Manager. A Business-Manager-only view of OCAPI settings will overstate the OCAPI share by missing SCAPI traffic. | Manual BM view overstates OCAPI |
| Sampling window. The card reflects a rolling traffic window; a point-in-time spike (e.g. a batch job) can skew a short snapshot. | Either, depends on window |
| Internal vs external calls. Some realm-internal calls may not be counted the same way as storefront traffic. | Minor |
Known limitations / merchant FAQs
Is there a target OCAPI/SCAPI mix I should aim for? There is no universal right answer. SCAPI is the strategic direction, so over a multi-year horizon a healthy realm trends toward more SCAPI. But a mature legacy realm running stable ISML storefronts on OCAPI is not “wrong” today. Watch the trend: a stalled mix quarter after quarter is the real signal, not the absolute number. Why is this card a Non-Hero with no alert? Because a given mix is not an incident. There is no value of this number that means “something is broken right now”. The acute risk lives on the version-status and failure-rate cards. This card is a strategic, roadmap-level artefact, best reviewed quarterly rather than monitored minute to minute. Does a high OCAPI share mean I am at immediate risk? Not immediately, but it is your exposure surface. Risk becomes concrete when a specific OCAPI version nears EOL. So read this card together with API Version Status: a high OCAPI share plus several near-EOL versions is a genuine warning; a high OCAPI share with long runways everywhere is just a long migration ahead. Why split by call volume and not by number of integrations? Call volume reflects where your real traffic and customer experience live. One high-traffic storefront can outweigh a dozen low-traffic back-office jobs. A by-integration count is useful for migration planning, but for “where does my live business run”, volume is the truer lens. The detailed cards give you the per-integration view. Will moving everything to SCAPI eliminate version-EOL risk? It removes the OCAPI deprecation-treadmill risk specifically, which is the big one. SCAPI is not on the same fixed retirement cadence. Individual SCAPI endpoints can still evolve, so it does not mean “never touch it again”, but it does take you off the predictable twice-a-year OCAPI EOL cycle that drives most of the firefighting. Is this real-time? Yes. The donut reflects the current observed call mix over a rolling window. There is no historical period selector, the time window isRT.