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 item-site level on-hand detail as used by the On Hand Detail screen
Resource: ItemSiteInventorySnapshot/
Verb: GET
Query String Options:
-
timeInterval:
- 2 = Weekly
- 4 = Monthly
- 8 = Quarterly
- 16 = Yearly
- showCurrentValues: true to show current day snapshot, false to omit
- showHistoricalValues: true to show historical values, false to omit
- showProjectedValues: true to show projected values, false to omit
Example URL
https://demo1.stockiqtech.net/api/ItemSiteInventorySnapshot?timeInterval=4&showCurrentValues=true&showHistoricalValues=true&showProjectedValues=false
Returns: JSON Array of ItemSiteHistory objects
Example Response JSON:
{
"Snapshots": [{
"SeriesKeyId": 1,
"SeriesKey": "0101001/44",
"CaptureDate": "2020/06/01",
"ItemSiteId": 1,
"ItemId": 1,
"SiteId": 5,
"ShipperId": 3,
"ItemCode": "0101001",
"SiteCode": "44",
"ItemDescription": "Contoso 512MB MP3 Player E51 Silver",
"ItemSiteCategory1Code": "01",
"ItemSiteCategory1Name": "Audio",
"ItemSiteCategory2Code": "0101",
"ItemSiteCategory2Name": "MP4&MP3",
"ItemSiteCategory3Code": "000",
"ItemSiteCategory3Name": "Unassigned",
"ItemSiteCategory4Code": "000",
"ItemSiteCategory4Name": "Unassigned",
"ItemSiteCategory5Code": "000",
"ItemSiteCategory5Name": "Unassigned",
"AbcClass": "X",
"StandardCost": 2.30000,
"OnHandQuantity": 5.00000,
"SafetyStockQuantity": 0.00000,
"TargetStockQuantity": 0.0000000,
"MaxStockQuantity": 0.00000,
"StandardCostOnHandBalance": 11.50000,
"StandardCostSafetyStockBalance": 0.000000000,
"StandardCostTargetStockBalance": 0.00000000,
"StandardCostMaxStockBalance": 0.000000000,
"OnHandCubes": 5.050000
}, {
"SeriesKeyId": 25,
"SeriesKey": "0101001/95",
"CaptureDate": "2020/06/01",
"ItemSiteId": 25,
"ItemId": 1,
"SiteId": 15,
"ShipperId": 3,
"ItemCode": "0101001",
"SiteCode": "95",
"ItemDescription": "Contoso 512MB MP3 Player E51 Silver",
"ItemSiteCategory1Code": "01",
"ItemSiteCategory1Name": "Audio",
"ItemSiteCategory2Code": "0101",
"ItemSiteCategory2Name": "MP4&MP3",
"ItemSiteCategory3Code": "000",
"ItemSiteCategory3Name": "Unassigned",
"ItemSiteCategory4Code": "000",
"ItemSiteCategory4Name": "Unassigned",
"ItemSiteCategory5Code": "000",
"ItemSiteCategory5Name": "Unassigned",
"AbcClass": "X",
"StandardCost": 2.30000,
"OnHandQuantity": 93.00000,
"SafetyStockQuantity": 0.00000,
"TargetStockQuantity": 0.0000000,
"MaxStockQuantity": 0.00000,
"StandardCostOnHandBalance": 213.90000,
"StandardCostSafetyStockBalance": 0.000000000,
"StandardCostTargetStockBalance": 0.00000000,
"StandardCostMaxStockBalance": 0.000000000,
"OnHandCubes": 93.930000
},
.....<more records>....
],
"ConstantLines": []