Description: This API has the item-by-item attribute information such as on-hand, ABC class, Inventory Position, Usage Pattern, and more.
Resource: ItemSiteAttributes/
Verb: GET
Parameters
- Optional:
- siteCode - specify the site code to filter by one particular site. This helps reduce size of the returned message as well
- itemCode - if you specify BOTH itemCode and siteCode, then you can get attributes for a single record. If you specify itemCode, you must specify a siteCode as well.
- https://demo1.stockiqtech.net/api/ItemSiteAttributes/
Returns: JSON Array of ItemSiteAttribute objects
Example Response JSON:
[{
"ItemSiteId": 4,
"ItemId": 14,
"SiteId": 11,
"ShipperId": 4,
"BuyerId": 0,
"PrimarySupplierId": 20,
"ActivePlanningLeadTime": 3,
"ItemCode": "0101003",
"SiteCode": "271",
"ShipperCode": "BBC",
"ItemDescription": "Contoso 1G MP3 Player E100 White",
"PrimarySupplierCode": "V0031",
"PrimarySupplierName": "Vendor V0031",
"MinimumOrderQuantity": 1,
"OrderMultipleQuantity": 1,
"OnHandQuantity": 70.00000,
"TotalOnHandBalance": 1545.60000,
"ActiveTargetStockBalance": 794.88000000,
"OpportunityDollars": 750.72000000,
"ActiveOrderPolicy": 2,
"InventoryPosition": 16,
"ReplacementFlags": 0,
"BoMPosition": 0,
"IsOnHandCopied": false,
"ActiveOrderCycle": 1,
"InventoryPositionAtLeadTime": 8,
"WorstProjectedInventoryPosition": 16,
"UsagePattern": 2,
"CurrentCost": 0.00000,
"StandardCost": 22.08000,
"StandardPrice": 22.08000,
"IsPhantom": false,
"AbcClass": "A",
"XyzClass": "X",
"ActiveSafetyStock": 12.00000,
"ActiveTargetStock": 36.0000000,
"ActiveMaxStock": 60.00000,
"TargetServiceLevel": 0.990000,
"ActiveReorderPoint": 24.51883,
"UnitOfMeasure": "CS",
"UnitWeight": 34.500000000000,
"UnitHeight": 0.972410000000,
"UnitCubes": 0.972410,
"Eoq": 28.039375490671318,
"TotalOnOrderQuantity": 0.00000,
"IndependentOnDemandOrderQuantity": 1.00000,
"DependentOnDemandOrderQuantity": 0.00000,
"IndependentOnDemandOrderQuantityToLeadTime": 1.00000,
"DependentOnDemandOrderQuantityToLeadTime": 0.00000,
"TotalAvailableQuantity": 69.00000,
"TotalAvailableQuantityAtLeadTime": 69.00000,
"ItemSiteCategory1Name": "Audio",
"ItemSiteCategory2Name": "MP4&MP3",
"ItemSiteCategory3Name": "Unassigned",
"ItemSiteCategory4Name": "Unassigned",
"ItemSiteCategory5Name": "Unassigned",
"ItemSiteCategory1Id": 8,
"ItemSiteCategory2Id": 2,
"ItemSiteCategory3Id": 1,
"ItemSiteCategory4Id": 1,
"ItemSiteCategory5Id": 1,
"ItemSiteNotes": "Over ride on forecast"
},
...
]
Usage Pattern Values:
New = 1,
Recurring = 2,
Sporadic = 4,
Slow = 8,
Dead = 16
Inventory Position Values:
OutOfStock = 1,
BelowPanicPoint = 2,
BelowSafetyStock = 4,
OK = 8,
PlannedOverstock = 16,
Overstocked = 24,
Excess = 32,
NeverStocked = 64,
NonStock = 128