Get forecast
Estimates how long a migration will take and how much capacity it needs, before you launch it. Uses the same forecaster as an actual kickoff, so the numbers match what a real run would be sized with. No run is created.
The forecast follows your run’s real scope:
selectionscopes the counts the ETA is priced from — a 10-of-10,000 product pick is not estimated as a whole-store run.conflict_strategyprices the extra workupdateandreplaceimply (reading the destination first, reconciling matched items, and forreplacea prune pass).- Orders are priced on the selected order statuses rather than the all-statuses total.
Calling this with only a source store means update/replace fall back to an assume-all-matched estimate, since the destination’s size isn’t known yet.
Authorizations
Your signed-in Vortex IQ session (browser calls). Requests are scoped to your organisation, which must have Store Migration enabled. For server-to-server calls use a bearer token instead — see Authentication.
Body
Counts and forecast read the source store only, so destination_store_hash is optional.
BigCommerce store hash to read.
Entity keys to count or price.
1Optional. Supplying it lets the forecast price update/replace against the destination's real size.
Selective migration picks. Parents and ancestors are included automatically, and products pull in their brands and categories.
Find the ids to pass here in the StagingPro app's Selective Migration tab. A selection also scopes entity counts and the forecast.
Forecast only: price the ETA for this strategy.
skip, update, replace Optional channel map.
Optional storefront scope.
x >= 1Optional storefront scope.
x >= 1Response
Sizing and ETA forecast.
Sizing and ETA estimate.
Sizing and ETA are priced from different bases deliberately: the ETA follows the run's real scope (picks, strategy, order statuses), while memory is pinned to store scale — the engine's working set does not shrink with a small pick, so sizing on picked counts alone would under-provision the run.
Per-entity counts the estimate was priced from, scoped by selection when supplied.
Count keys that are sampled estimates rather than exact totals.
Memory the run will be given (MiB). Pinned to store scale, not to the picked subset.
CPUs the run will be given.
Estimated total wall-clock for the run.
Per-phase seconds.
The blended latency the estimate assumed.
Per-operation-class latencies the estimate assumed, so heavy writes are not judged against a blended baseline.
The conflict strategy the ETA was priced with. Absent means create-only.
skip, update, replace Destination catalogue size at kickoff. Absent or 0 when the destination wasn't known.
Capacity band the run was placed in.
small, medium, large, xlarge, xxlarge, xxxlarge fallback means counts were unavailable and defaults were used.
forecast, fallback, fix