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 lost sales detail grid from the Lost Sales screen in the Forecast module
Resource: LostSalesDetail/
Verb: GET
Query String Arguments
-
interval (required):
- 2 = Weekly
- 4 = Monthly
- 8 = Quarterly
- 16 = Yearly
-
fillInMissingPeriods (required):
- true
- false
- nodeLevel (required): Hierarchy Node Level. Top company level = 0. This corresponds to the levels you have configured in Forecast Manager's tree view
Returns: JSON Array containing records matching lost sales details
Example Response JSON:
[{AbcClass: "A"
CustomerShipToCategory1Value: "Sam's Club"
HierarchyNodeId: 3968
ItemCode: "0101003"
ItemDescription: "Contoso 1G MP3 Player E100 White"
ItemId: 1
ItemSiteCategory1Code: "01"
ItemSiteCategory1Name: "Audio"
ItemSiteCategory2Code: "0101"
ItemSiteCategory2Name: "MP4&MP3"
ItemSiteCategory3Code: "000"
ItemSiteCategory3Name: "Unassigned"
ItemSiteCategory4Code: "000"
ItemSiteCategory4Name: "Unassigned"
ItemSiteCategory5Code: "000"
ItemSiteCategory5Name: "Unassigned"
ItemSiteId: 3
LostCogs: 511.45551
LostQuantity: 21.92058
LostRevenue: 511.45551
NodeLevel: 5
PeriodDate: "2023/02/01"
SiteCode: "271"
XyzClass: "X"}
,
{AbcClass: "C"
CustomerShipToCategory1Value: "Tier 2 Customers"
HierarchyNodeId: 4010
ItemCode: "0104003"
ItemDescription: "WWI 1GB Pulse Smart pen E50 Silver"
ItemId: 30
ItemSiteCategory1Code: "01"
ItemSiteCategory1Name: "Audio"
ItemSiteCategory2Code: "0104"
ItemSiteCategory2Name: "Recording Pen"
ItemSiteCategory3Code: "000"
ItemSiteCategory3Name: "Unassigned"
ItemSiteCategory4Code: "000"
ItemSiteCategory4Name: "Unassigned"
ItemSiteCategory5Code: "000"
ItemSiteCategory5Name: "Unassigned"
ItemSiteId: 49
LostCogs: 4937.215
LostQuantity: 13.8128
LostRevenue: 6090.3
NodeLevel: 5
PeriodDate: "2023/04/01"
SiteCode: "95"
XyzClass: "X"}
,
... ]