Forecasting

GET /cx/v1/forecast/restock

The Inventory Planner’s reorder queue: what to order, how much, and by when, from stock on hand, inbound units, sales velocity and lead time.

Param	Default	Notes
`category`		Filter to one category
`limit`	100	1 to 500
`sku`		One product

{
  "category": null,
  "windowDays": 14,
  "count": 100,
  "totalPlanable": 412,
  "items": [
    {
      "sku": "SF-1042",
      "title": "Harbor Sofa",
      "category": "Sofas",
      "atp": 3,
      "backordered": 4,
      "inTransit": 0,
      "nextAvailable": null,
      "unitsPerMonth": 6.5,
      "runwayWeeks": 2.0,
      "leadTimeDays": 90,
      "orderBy": "2026-07-16",
      "daysUntilOrderBy": -90,
      "status": "past",
      "suggestedQty": 24
    }
  ]
}

status is past, due or ok.
404 not_tracked until your account has an inventory snapshot. 404 product_not_tracked when the ?sku= isn’t in the planned set.
Titles can repeat across SKUs, so show the SKU with the title.

GET /cx/v1/forecast/top/{range}

Products ranked by projected views in the window. ?top= 1 to 100, default 25.

{
  "range": "this_month",
  "count": 25,
  "products": [
    {
      "productId": "SF-1042",
      "title": "Harbor Sofa",
      "imageLink": "https://…",
      "projectedViews": 4210,
      "projectedUniqueUsers": 3180,
      "contacts": 112,
      "locations": 3,
      "places": 14
    }
  ]
}

GET /cx/v1/products/{id}/forecast/{range}

One product’s forecast: the prediction series plus projected units by store.

{
  "range": "this_quarter",
  "productId": "SF-1042",
  "title": "Harbor Sofa",
  "series": [
    { "date": "2026-09-01", "grain": "day", "views": 140, "uniqueUsers": 104 }
  ],
  "projectedSalesByStore": [
    { "storeId": "S01", "projectedUnits": 9 }
  ]
}

GET /cx/v1/forecast/similarity

All similarity forecasts, newest first. Returns 404 similarity_forecast_not_available until similarity forecasts have been produced for your account.

{
  "count": 4,
  "forecasts": [
    {
      "id": "…",
      "name": "Curved-back lounge concept",
      "category": "Chairs",
      "status": "complete",
      "imageLink": "https://…",
      "projectedViews": 1840,
      "projectedUniqueUsers": 1420,
      "contacts": 40,
      "locations": 2,
      "places": 8,
      "modified": "2026-08-14",
      "similarProducts": 6
    }
  ]
}

GET /cx/v1/forecast/similarity/{id}

One similarity forecast in full: the prediction series, the comparable products it was built from (with similarity scores), and projected units by store.

{
  "forecast": {
    "id": "…",
    "name": "…",
    "category": "…",
    "description": "…",
    "status": "complete",
    "imageLink": "…",
    "projectedViews": 1840
  },
  "series": [
    { "date": "2026-09-01", "grain": "day", "views": 61, "uniqueUsers": 48 }
  ],
  "similarProducts": [
    { "productId": "…", "title": "…", "link": "…", "imageLink": "…", "similarityScore": 0.9142 }
  ],
  "projectedSalesByStore": [
    { "storeId": "S01", "projectedUnits": 4 }
  ]
}

Was this helpful?

Still stuck? Contact support and include the job or page you were on.