Skip to main content

API: Alert Detail

Updated

Description: Returns each alert record with details information about the alert, including sortable/filterable columns for each alert.

Resource: AlertDetail/

Verb: GET

Query String Options:

  • alertTypeIds: which alert types you want returned
    • StockOut = 1,
      SlowMover = 2,
      DeadStock = 3,
      ItemSiteServiceLevel = 4,
      Backorders = 5,
      LateSupplyOrder = 6,
      InventoryExpiration = 7,
      UnderForecast = 8,
      OverForecast = 9,
      ForecastErrorHistory = 10,
      ForecastVsModel = 11,
      CurrentExcess = 12,
      NewItem = 13,
      UnusualSales = 14,
      PlanAtRisk = 15,
      SafetyStock= 16,
      CriticalOrder = 17,
      PromotionFrequency = 18,
      PromotionDepth = 19,
      PromotionLength = 20,
      OrderStatus = 21,
      ProjectedStockOut = 22,
      ProjectedExcess = 23,
      LargeMinMult = 24
  • alertPriorityIds: which alert priorities you want:
    • 1 = low
    • 2 = medium
    • 4 = high
    • Example: &alertPriorityIds=2&alertPriorityIds=4 for medium and high priority
  • alertStateIds: which alert states you want
    • 1 = Active
    • 2 = Suspended
    • 4 = Reactivated

Returns: JSON Array of AlertDetail objects.

Example Response JSON:

[{
"ATN": "CriticalOrder",
"ItemSiteSupplierId": 2300,
"ShipperId": 1,
"ItemId": 927,
"SiteId": 13,
"BuyerId": 4,
"ItemSiteId": 1779,
"SupplierId": 51,
"ItemCode": "0602004",
"SiteCode": "96",
"PrimarySupplierCode": "V0055",
"PrimarySupplierName": "Howe Electronics",
"ItemDescription": "SV DVD Player M130 Grey",
"AbcClass": "C",
"XyzClass": "X",
"BuyerName": "Jim Clark",
"ActiveOrderPolicy": 2,
"ItemSiteCategory1Id": 6,
"ItemSiteCategory2Id": 18,
"ItemSiteCategory3Id": 1,
"ItemSiteCategory4Id": 1,
"ItemSiteCategory5Id": 1,
"ItemSiteCategory1Name": "Music, Movies and Audio Books",
"ItemSiteCategory2Name": "Movie DVD",
"ItemSiteCategory3Name": "Unassigned",
"ItemSiteCategory4Name": "Unassigned",
"ItemSiteCategory5Name": "Unassigned",
"AlertSummaryId": 2325,
"AlertKeyId": 2300,
"PrimaryId": 2300,
"PrimaryIdProperty": 2,
"Rank": 65,
"APri": 4,
"ASt": 1,
"AlertType": 17,
"AMsg": "This item is projected to stock out. Launch order for 150 today, or check the expedite screen for expedite options. ",
"DateCreated": "2023/06/01",
"DateUpdated": "2023-06-01T00:00:00-05:00"
},
{
"ATN": "CriticalOrder",
"ItemSiteSupplierId": 2266,
"ShipperId": 1,
"ItemId": 927,
"SiteId": 17,
"BuyerId": 4,
"ItemSiteId": 1763,
"SupplierId": 47,
"ItemCode": "0602004",
"SiteCode": "44",
"PrimarySupplierCode": "V0057",
"PrimarySupplierName": "Xiamen Manufacturing Group",
"ItemDescription": "SV DVD Player M130 Grey",
"AbcClass": "D",
"XyzClass": "X",
"BuyerName": "Jim Clark",
"ActiveOrderPolicy": 2,
"ItemSiteCategory1Id": 6,
"ItemSiteCategory2Id": 18,
"ItemSiteCategory3Id": 1,
"ItemSiteCategory4Id": 1,
"ItemSiteCategory5Id": 1,
"ItemSiteCategory1Name": "Music, Movies and Audio Books",
"ItemSiteCategory2Name": "Movie DVD",
"ItemSiteCategory3Name": "Unassigned",
"ItemSiteCategory4Name": "Unassigned",
"ItemSiteCategory5Name": "Unassigned",
"AlertSummaryId": 2775,
"AlertKeyId": 2266,
"PrimaryId": 2266,
"PrimaryIdProperty": 2,
"Rank": 41,
"APri": 4,
"ASt": 1,
"AlertType": 17,
"AMsg": "This item is projected to stock out. Launch order for 264 today, or check the expedite screen for expedite options. ",
"DateCreated": "2023/06/01",
"DateUpdated": "2023-06-01T00:00:00-05:00"
},
 {
"ATN": "ForecastError",
"HierarchyNodeId": 6353,
"NodeLevel": 5,
"HierarchyProperty": 2048,
"ShipperId": 4,
"SiteId": 8,
"ItemId": 1392,
"BuyerId": 7,
"CustomerShipToCategory1Id": 8,
"ItemSiteCategory1Id": 7,
"ItemSiteCategory2Id": 31,
"ItemSiteCategory3Id": 1,
"ItemSiteCategory4Id": 1,
"ItemSiteCategory5Id": 1,
"ItemSiteCategory6Id": 1,
"ItemSiteCategory7Id": 1,
"ItemSiteCategory8Id": 1,
"ItemSiteId": 2593,
"ShipperName": "Shipper ABC",
"ItemCode": "0808039",
"ItemDescription": "Litware 92mm DBB Case Fan E1101 Black",
"SiteCode": "111",
"SiteName": "Contoso Tampa Store",
"CustomerShipToCategory1Value": "Tier 2 Customers",
"ItemSiteCategory1Name": "Home Appliances",
"ItemSiteCategory2Name": "Fans",
"ItemSiteCategory3Name": "Unassigned",
"ItemSiteCategory4Name": "Unassigned",
"ItemSiteCategory5Name": "Unassigned",
"ItemSiteCategory6Name": "Unassigned",
"ItemSiteCategory7Name": "Unassigned",
"ItemSiteCategory8Name": "Unassigned",
"AbcClass": "C",
"XyzClass": "X",
"ActiveOrderPolicy": 2,
"ResolvedItemStatus": 1,
"PrimarySupplierCode": "139",
"PrimarySupplierName": "Warehouse 139 - Contoso New Brunswick Store",
"BuyerName": "Richard Petty",
"AlertSummaryId": 4857,
"AlertKeyId": 16353,
"PrimaryId": 6353,
"PrimaryIdProperty": 3,
"Rank": 859,
"APri": 4,
"ASt": 1,
"AlertType": 10,
"AMsg": "Forecast error of 321.79% results in error of 15.55, worth $1,653.22, which is outside allowed range. Check for unusual demand or poor forecasts.",
"DateCreated": "2024/06/17",
"DateUpdated": "2024-06-17T00:00:00-05:00"
},
]

Related articles