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 Stockouts detail grid from the Stockouts screen in the Inventory module
Resource: StockOutsDetail/
Verb: GET
Returns: JSON Array of stockout objects
Query String Arguments:
- includeNonStockPolicies (required)- true or false. Whether or not you want to include stockouts for items with non-stock policies
- includeItemsWithZeroSafetyStock (required)- true or false. Whether or not you want to include stockouts for items with zero safety stock
- includeReplacedItems (required)- true or false. Whether or not you want to include stockouts for items that are replaced with a newer version
- numberOfDaysToCheckForRecentStockouts (required)- number (default 90). Number of days you want StockIQ to look for stockouts
Example JSON:
[{
"AlertKeyId": 14,
"AlertType": 1,
"PrimaryId": 14,
"PrimaryIdProperty": 1,
"NumberOfTimesHaveBeenOut": 0,
"ProjectedInStockDate": "2024-07-02T00:00:00",
"IsOutOfStockInSiteGroup": true,
"ItemSiteId": 14,
"OutOfStockQuantity": 0.00000,
"ShipperId": 4,
"ItemId": 13,
"SiteId": 13,
"PrimarySupplierId": 31,
"ItemCode": "0101010",
"SiteCode": "261",
"SiteGroupName": "Asia",
"BuyerName": "Lewis Hamilton",
"ItemDescription": "Contoso 4G MP3 Player E400 Green",
"ActiveOrderPolicy": 4,
"ResolvedItemStatus": 1,
"ActiveSafetyStock": 462.00000,
"AbcClass": "C",
"XyzClass": "Y",
"CurrentCost": 5.00000,
"StandardCost": 5.00000,
"StandardPrice": 8.00000,
"PrimarySupplierName": "Eisen Wholesale",
"TargetServiceLevel": 0.900000,
"LeadTime": 15,
"TotalOnHandQuantity": 0.00000,
"TotalAvailableQuantity": 0.00000,
"TotalAvailableQuantityAtLeadTime": 0.00000,
"TotalOnOrderQuantity": 0.00000,
"TotalHistoricalDailyUsage": 0.0,
"InventoryPosition": 1,
"LostRevenuePerDay": 0.0,
"TotalOnDemandOrderQuantity": 0.00000,
"TotalOnDemandValue": 0.00000,
"ItemSiteCategory1Name": "Audio",
"ItemSiteCategory2Name": "MP4&MP3",
"ItemSiteCategory3Name": "Unassigned",
"ItemSiteCategory4Name": "Unassigned",
"ItemSiteCategory5Name": "Unassigned",
"ItemSiteCategory6Name": "Unassigned",
"ItemSiteCategory7Name": "Unassigned",
"ItemSiteCategory8Name": "Unassigned",
"SiteGroupInventoryPosition": 1,
"SiteGroupUsagePattern": 2,
"SiteGroupOnHandQuantity": 0.00000,
"SiteGroupAvailableQuantity": 0.00000,
"ReplacementFlags": 0,
"IsOnHandCopied": false,
"ItemSiteCategory1Id": 3,
"ItemSiteCategory2Id": 31,
"ItemSiteCategory3Id": 1,
"ItemSiteCategory4Id": 1,
"ItemSiteCategory5Id": 1,
"ItemSiteCategory6Id": 1,
"ItemSiteCategory7Id": 1,
"ItemSiteCategory8Id": 1,
"BuyerId": 2,
"BoMPosition": 0,
"SupplierItemCode": "0101010",
"AlertSummaryId": 0,
"DateCreated": "0001-01-01T00:00:00",
"DateUpdated": "0001-01-01T00:00:00+00:00",
"ASt": 0,
"APri": 0,
"AlertTypeName": "StockOut"
}, ...]