getCurrentInventoryByPage
Retrieve the current inventory for a product or subset of products.
Query parameters
The code that identifies the location in Crunchtime.
The code number for the product to retrieve. (case sensitive).
The Lot Number associated with the product in inventory.
Flag to control whether products are summed for the entire location or separated by storage location. Valid values are 'true' or 'false'. When 'true', results are aggregated across all storage locations and ordered by locationCode and productNumber. When 'false', results are separated by storage location and ordered by locationCode, storageName and productNumber. If left blank, the default is 'true'.
The category name assigned to the product. Use 3 or more characters.
The subcategory name assigned to the product. Use 3 or more characters.
The microcategory name assigned to the product. Use 3 or more characters.
Retrieve one or more records by pageNumber. Use to retrieve data in smaller chunks. If left blank, the default is 1.
Number of items to display per page.
Specify 'true' to output null data elements.
Headers
Secure token for API authentication.
Password for the Crunchtime Application User.
Crunchtime site identifier. (test or production)
User ID for the Crunchtime Application User.
Optional trace identifier for troubleshooting.
Response
Success
Example response
{
"currentInventoryDetails": [
{
"currentInventoryDetailDetails": [
{
"locationCode": "BS002",
"locationName": "Boston Store",
"storageName": "Produce Cooler",
"storageCode": "0004",
"productName": "Romaine Lettuce",
"lotNumber": "165R-13593",
"categoryName": "FOOD",
"subcategoryName": "PRODUCE",
"microcategoryName": "VEGETABLE",
"glCode": "5010-0005",
"glDescription": "Produce",
"inventoryUnit": "LB",
"onHandQuantity": 24,
"onHandValue": 35.7,
"inTransitQuantity": 4.5,
"inTransitValue": 7.49,
"totalQuantity": 45.8,
"totalValue": 98.58,
"customerOrderQuantity": 7.5,
"vendorOrderQuantity": 20
}
]
}
]
}