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 the period-by-period detail used in the Forecast Analysis screen at the lowest (bottom) level of your forecast hierarchy, e.g. the most specific level of detail.
Some property names are shortened to reduce download/parse time.
Resource: BottomLevelForecastDetail/fetchby/dateRangeHierarchyNodeFilters/
Verb: POST
Query String Options:
-
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
Example URL:
https://demo1.stockiqtech.net/api/BottomLevelForecastDetail?interval=4&demandForecastSeriesId=1
Returns: JSON Array of ForecastDetail objects
Example Response JSON:
I = ItemCode
S = Site Code
SN = Site Name
A = PeriodDate,
B = ForecastedQty,
C = Cogs,
D = Revenue,
E = Margin
ISC1-5 = Item Site Category 1-5
CSC1-3 = Customer Ship To Category 1-3 (CSC1 is usually forecast group if being used)
[{
"HierarchyNodeId": 4632,
"ShpN": "Shipper CCC",
"I": "0308026",
"S": "300",
"SN": "Contoso Sydney No.2 Store",
"ISC1": "Computers",
"ISC2": "Computers Accessories",
"ISC3": "Unassigned",
"ISC4": "Unassigned",
"ISC5": "Unassigned",
"CSC1": "Unassigned",
"Desc": "Contoso ADSL Modem Splitter/Filter X 1 E100 Black",
"AbcClass": "C",
"A": "2020/01/01",
"B": 4.00000,
"C": 49.67520,
"D": 60.00000,
"E": 10.32480,
"Ohb": 0.000000000
}, {
"HierarchyNodeId": 4632,
"ShpN": "Shipper CCC",
"I": "0308026",
"S": "300",
"SN": "Contoso Sydney No.2 Store",
"ISC1": "Computers",
"ISC2": "Computers Accessories",
"ISC3": "Unassigned",
"ISC4": "Unassigned",
"ISC5": "Unassigned",
"CSC1": "Unassigned",
"Desc": "Contoso ADSL Modem Splitter/Filter X 1 E100 Black",
"AbcClass": "C",
"A": "2021/05/01",
"B": 10.00000,
"C": 144.18800,
"D": 170.00000,
"E": 25.81200,
"Ohb": 0.000000000
}, {
"HierarchyNodeId": 4644,
"ShpN": "Shipper CCC",
"I": "0308026",
"S": "300",
"SN": "Contoso Sydney No.2 Store",
"ISC1": "Computers",
"ISC2": "Computers Accessories",
"ISC3": "Unassigned",
"ISC4": "Unassigned",
"ISC5": "Unassigned",
"CSC1": "Tier 2 Customers",
"Desc": "Contoso ADSL Modem Splitter/Filter X 1 E100 Black",
"AbcClass": "C",
"A": "2021/06/01",
"B": 5.89103,
"C": 84.94158,
"D": 100.14751,
"E": 15.20593,
"Ohb": 0.000000000
}
...
]