Skip to main content

API: Hierarchy Service Level Detail (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 hierarchy level service level detail grid from the Service Level screen in the Inventory module

Resource: HierarchyLevelServiceLevelDetail/

Verb: GET

Query String Arguments

  • interval (required):
    • 2 = Weekly
    • 4 = Monthly
    • 8 = Quarterly
    • 16 = Yearly
  • startDate (optional) - Limit result set to a particular date
  • hierarchyLevel (required): Hierarchy Node Level. Top company level = 0. This corresponds to the levels you have configured in Forecast Manager's tree view
  • itemHierarchyId (required): which hierarchy is being used, usually "1"

Returns: JSON Array containing records matching hierarchy level service level details

Example Response JSON:

[{
       "FillRate": 0.9445349489920437350514960707,
       "OnTimeFillRate": 0.9445349489920437350514960707,
       "ServiceLevel": 0.9829424981803221620937371436,
       "ServiceLevelVariance": 0.0159794981803221620937371436,
       "HierarchyNodeId": 1,
       "ValueId": 0,
       "HierarchyProperty": 0,
       "NodeTitle": "Unassigned",
       "PeriodDate": "2023-06-01T00:00:00",
       "StartDate": "2023-06-01T00:00:00",
       "EndDate": "2023-06-30T00:00:00",
       "TargetServiceLevel": 0.966963,
       "NumberOfOrderLines": 31599,
       "QuantityOrdered": 327792,
       "QuantityFilled": 309611,
       "QuantityFilledOnTime": 309611,
       "NumberOfCompleteOrderLines": 31060,
       "NumberOfOnTimeCompleteOrderLines": 31060
   },
   {
       "FillRate": 0.887951568325528222025836428,
       "OnTimeFillRate": 0.887951568325528222025836428,
       "ServiceLevel": 0.9776683177906301021114093588,
       "ServiceLevelVariance": 0.0103863177906301021114093588,
       "HierarchyNodeId": 1,
       "ValueId": 0,
       "HierarchyProperty": 0,
       "NodeTitle": "Unassigned",
       "PeriodDate": "2023-07-01T00:00:00",
       "StartDate": "2023-07-01T00:00:00",
       "EndDate": "2023-07-31T00:00:00",
       "TargetServiceLevel": 0.967282,
       "NumberOfOrderLines": 36137,
       "QuantityOrdered": 408493,
       "QuantityFilled": 362722,
       "QuantityFilledOnTime": 362722,
       "NumberOfCompleteOrderLines": 35330,
       "NumberOfOnTimeCompleteOrderLines": 35330
   },
... ]

 

 

 

 


 

Related articles