Skip to main content

API: Forecast Analysis - Item-Site (Legacy)

Updated

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 item-site level

Resource: ItemSiteForecastDetail/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

Returns: JSON Array of ForecastDetail objects

Example URL

https://demo5.stockiqtech.net/api/ItemSiteForecastDetail/fetchby/dateRangeHierarchyNodeFilters/?interval=4&demandForecastSeriesId=1 

Example Response JSON:

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

[
  {
    "ItemSiteId": 61,
    "ICode": "0104014",
    "SCode": "96",
    "Desc": "WWI 1GB Digital Voice Recorder Pen E100 Pink",
    "A": "2020/09/01",
    "AbcClass": "A",
    "ISC1": "Audio",
    "ISC2": "Recording Pen",
    "ISC3": "Unassigned",
    "ISC4": "Unassigned",
    "ISC5": "Unassigned",
    "ISC6": "Unassigned",
    "ISC7": "Unassigned",
    "ISC8": "Unassigned",
    "SupplierItemCode": "0104014",
    "PrimarySupplierName": "Xiamen Manufacturing Group",
    "ActualQuantitySold": 1336.00000,
    "ActualCogs": 22591.76000,
    "ActualRevenue": 23660.56000,
    "ActualMargin": 1068.80000,
    "StatisticalForecastUnits": 1152.00102,
    "StatisticalForecastErrorUnits": -183.99898,
    "StatisticalForecastErrorPercent": -0.1377237874251497005988023952
  },
  {
    "ItemSiteId": 61,
    "ICode": "0104014",
    "SCode": "96",
    "Desc": "WWI 1GB Digital Voice Recorder Pen E100 Pink",
    "A": "2020/10/01",
    "AbcClass": "A",
    "ISC1": "Audio",
    "ISC2": "Recording Pen",
    "ISC3": "Unassigned",
    "ISC4": "Unassigned",
    "ISC5": "Unassigned",
    "ISC6": "Unassigned",
    "ISC7": "Unassigned",
    "ISC8": "Unassigned",
    "SupplierItemCode": "0104014",
    "PrimarySupplierName": "Xiamen Manufacturing Group",
    "ActualQuantitySold": 2232.00000,
    "ActualCogs": 37743.12000,
    "ActualRevenue": 39528.72000,
    "ActualMargin": 1785.60000,
    "StatisticalForecastUnits": 1911.39194,
    "StatisticalForecastErrorUnits": -320.60806,
    "StatisticalForecastErrorPercent": -0.1436416039426523297491039427
  },
...
]

Related articles