NOTE: This is an article for the legacy API. To access updated information on this endpoint, please reference the HTML guide attached to the bottom of the REST API Access document
Description: Returns results from Manual Forecast vs Statistical tab in Manual Forecasts screen in Forecast Module
Resource: ForecastVsModelDetail/fetchby
Verb: POST
Query String Options:
- itemHierarchyId (required): which hierarchy is being used, usually "1"
- demandForecastSeriesId (required): which forecast series to view, usually "1"
- nodeLevel (required): Hierarchy Node Level. Top company level = 0. This corresponds to the levels you have configured in Forecast Manager's tree view
- hierarchyNodeFilters (required): filters from the Filters Panel
- showInheritedSettings (required): whether or not you'd like to see inherited forecasts from parents
Example URL: https://demo4.stockiqtech.net/api/ForecastVsModelDetail/fetchby/hierarchyNodeFilters/?itemHierarchyId=1&demandForecastSeriesId=1&nodeLevel=5
Returns: JSON Array of Manual Forecast vs Statistical Model objects
Example Response JSON:
[
{
"AlertKeyId": 1202501014005,
"AlertType": 11,
"PrimaryId": 4005,
"PrimaryIdProperty": 3,
"LevelName": "Customer Group",
"ItemTagAssignments": [],
"NodeLevel": 5,
"HierarchyProperty": 2048,
"ShipperId": 3,
"ItemId": 10,
"SiteId": 14,
"BuyerId": 9,
"ItemSiteId": 29,
"ItemSiteCategory1Id": 9,
"ItemSiteCategory2Id": 21,
"ItemSiteCategory3Id": 1,
"ItemSiteCategory4Id": 1,
"ItemSiteCategory5Id": 1,
"ItemSiteCategory6Id": 1,
"ItemSiteCategory7Id": 1,
"ItemSiteCategory8Id": 1,
"CustomerShipToCategory1Id": 7,
"DemandForecastSeriesName": "Operational Forecast",
"NodeValue": "Amazon",
"HierarchyNodeId": 4005,
"DemandForecastSeriesId": 1,
"PeriodDate": "2025/01/01",
"Interval": 4,
"ForecastQuantity": 2411.81311,
"StatisticalForecastQuantity": 2411.81311,
"ForecastAverageQuantity": 1519.61043,
"StatisticalAverageQuantity": 1519.61043,
"ForecastRevenue": 18040.36206,
"StatisticalForecastRevenue": 0.00000,
"AverageForecastErrorPercent": 0.75784,
"AverageStatisticalErrorPercent": 0.36977,
"ForecastVsStatisticalUnitVariance": 0.00000,
"ForecastVsStatisticalDollarVariance": 18040.36206,
"UsagePattern": 2,
"ForecastControl": 1,
"AutoForecastReactivationDate": "2024/12/01",
"ShipperName": "Shipper ABC",
"ItemCode": "0101022",
"SiteCode": "95",
"PrimarySupplierName": "Warehouse 96 - Contoso Hub",
"BuyerName": "Juan Fangio",
"CustomerShipToCategory1Value": "Amazon",
"ItemDescription": "Contoso 8GB MP3 Player new model M820 Yellow",
"ItemSiteCategory1Name": "Audio",
"ItemSiteCategory2Name": "MP4&MP3",
"ItemSiteCategory3Name": "Unassigned",
"ItemSiteCategory4Name": "Unassigned",
"ItemSiteCategory5Name": "Unassigned",
"ItemSiteCategory6Name": "Unassigned",
"ItemSiteCategory7Name": "Unassigned",
"ItemSiteCategory8Name": "Unassigned",
"AbcClass": "A",
"XyzClass": "X",
"ActiveOrderPolicy": 2,
"ResolvedItemStatus": 1,
"AlertSummaryId": 0,
"DateCreated": "0001/01/01",
"DateUpdated": "0001-01-01T00:00:00+00:00",
"ASt": 0,
"APri": 0,
"AlertTypeName": "ForecastVsModel"
},
...
]