Reports

Product Usage Report - Returns stock flow data with optional filtering by warehouse, client, product, flow type, date range, and search

get/api/Reports/ProductUsageReport

Request

  • Base URL: https://api.mintsoft.co.uk
  • URL: https://api.mintsoft.co.uk/api/Reports/ProductUsageReport
  • Auth: API key in header ms-apikey

Query parameters

warehouseIdinteger

Optional - Filter the results by Warehouse

clientIdinteger

Optional - Filter the results by Client

productIdinteger

Optional - Filter the results by Product

flowstring

Optional - Filter the results by Flow Type (e.g., IN, OUT, ALLOCATE, UNALLOCATE)

fromDatestring date-time

Optional - Filter results from this date

toDatestring date-time

Optional - Filter results to this date

includeDetailsboolean

Optional - Include a breakdown of the details like Location, batch numbers and serial numbers

searchstring

Optional - General search across reason, user, SKU, and batch numbers

pageNointeger

Optional - Page number for pagination (default: 1)

limitinteger

Optional - Number of records per page (default: 1000, max: 1000)

Response

OK

IDinteger
Clientstring
StockFlowIdinteger
SKUstring
Warehousestring
Quantityinteger
NewStockLevelinteger
NewAllocatedLevelinteger
NewOnHandLevelinteger
NewOffHandLevelinteger
Flowstring
Reasonstring
Userstring
Datestring
ExtraInfostring
CartonCodestring
PalletCodestring
ExternalOrderReferencestring

Changes

No recorded changes to this operation across all 1 revision of this API.