API: Forecast Analysis - Hierarchy Level

Description: Returns the period-by-period detail used in the Forecast Analysis screen at the selected hierarchy level

Resource: HierarchyLevelForecastDetail/fetchby/dateRangeHierarchyNodeFilters

Verb: POST

Query String Options:

• hierarchyLevel (required): the level in which you'd like forecast details for
• itemHierarchyId (required): the item hierarchy you'd like forecast details for, usually "1"
• interval (required):
  • 2 = Weekly
  • 4 = Monthly
  • 8 = Quarterly
  • 16 = Yearly
• demandForecastSeriesId (required): which forecast series to view, usually "1"
• startDate (optional): first date to filter by, e.g. 1/1/2020

Returns: JSON Array of ForecastDetail objects

Example URL
https://demo5.stockiqtech.net/api/HierarchyLevelForecastDetail/fetchby/dateRangeHierarchyNodeFilters/?interval=4&demandForecastSeriesId=1&itemHierarchyId=1&hierarchyLevel=3 

Example Response JSON:

A = PeriodDate, B = Quantity, C = Cogs, D = Revenue, E = Margin

[
  {
    "HierarchyNodeId": 73,
    "HierarchyProperty": 1,
    "NodeTitle": "Audio -> Recording Pen -> 0104014",
    "A": "2020/09/01",
    "Ohb": 0.000000000,
    "ActualQuantitySold": 1336.00000,
    "ActualCogs": 22591.76000,
    "ActualRevenue": 23660.56000,
    "ActualMargin": 1068.80000
  },
  {
    "HierarchyNodeId": 477,
    "HierarchyProperty": 1,
    "NodeTitle": "Computers -> Computers Accessories -> 0308132",
    "A": "2020/09/01",
    "Ohb": 0.000000000,
    "ActualQuantitySold": 22152.00000,
    "ActualCogs": 130253.76000,
    "ActualRevenue": 138228.48000,
    "ActualMargin": 7974.72000
  },
...
]