Inventory assets report | Distru Documentation

Stock per product and location, split by batch or package, with prices and costs.

Inputs

Every tool also takes the common inputs.

Field	Type	Required	Description
cursor	string	No	nextCursor of the previous call; keep the other arguments unchanged.
locationId	string	No	Resolve via distru-search-locations.
snapshotDatetime	string	No	Defaults to now. Not before 2023-08-03T11:00:00Z. ISO 8601 with a UTC offset, e.g. "2026-09-01T00:00:00-07:00"; the company timezone is on distru-get-me.
productCategoryIds	string[]	No	Product category of the rows. ORed with productSubcategoryIds; a listed subcategory of a listed category narrows that category to it. Resolve via distru-search-lookups (type PRODUCT_CATEGORY).
productSubcategoryIds	string[]	No	Product subcategory of the rows. See productCategoryIds. Resolve via distru-search-lookups (type PRODUCT_CATEGORY, each row's subcategories).
productTagIds	string[]	No	Any of these tags on the product. Resolve via distru-search-lookups (type PRODUCT_TAG).
vendorIds	string[]	No	The vendor set on the product, not the company an order was placed with. Resolve via distru-search-companies.
brandIds	string[]	No	Product brand of the rows, itself a company. Resolve via distru-search-companies, or read it on a distru-search-products row.
productGroupIds	string[]	No	Resolve via distru-search-lookups (type PRODUCT_GROUP).
maxRowsLimit	integer	No	Rows per page. Defaults to 500.

Output

Presence on a nested field assumes its parent exists.

Field	Type	Presence	Description
nextCursor	string	Can be absent	Pass as cursor to fetch the next page. Present only when meta.truncated.
meta	object	Always
meta.report	string	Always
meta.dateRange	string	Always
meta.rowLimit	number	Always
meta.offset	number	Always
meta.rowCount	number	Always
meta.totalRowCount	number	Always
meta.truncated	boolean	Always
meta.columns	object[]	Always
meta.columns[].key	string	Always
meta.columns[].label	string	Always
rows	object[]	Always
rows[].product	string	Always
rows[].productId	string	Always
rows[].license	string	Can be null
rows[].licenseId	string	Can be null
rows[].location	string	Can be null
rows[].locationId	string	Can be null
rows[].packageNumber	string	Can be null
rows[].packageId	string	Can be null
rows[].batchNumber	string	Can be null
rows[].batchId	string	Can be null
rows[].sku	string	Always
rows[].vendor	string	Always
rows[].vendorId	string	Always
rows[].owner	string	Can be null
rows[].unitType	string	Always
rows[].activeQuantity	string	Always
rows[].assemblingQuantity	string	Always
rows[].sellingQuantity	string	Always
rows[].category	string	Always
rows[].subcategory	string	Can be null
rows[].unitPrice	string	Always
rows[].unitCostActual	string	Can be null
rows[].unitCostDefault	string	Can be null
rows[].totalCostActual	string	Can be null
rows[].totalCostDefault	string	Can be null
rows[].expirationDate	string	Can be null
rows[].trackingMethod	enum `BATCHPACKAGEPRODUCT`	Always
rows[].harvestDate	string	Can be null
rows[].labTestingState	enum `FAILEDNOT_TESTEDPASSEDPENDING`	Can be null
rows[].customFields	object[]	Always
rows[].customFields[].key	string	Always
rows[].customFields[].label	string	Always
rows[].customFields[].value	string	Can be null

What the AI reads

Stock per asset: one row per product at a location, split by batch or package when the product is tracked that way, with active, assembling and selling quantities, unit price and costs. A snapshot as of now or snapshotDatetime. Use for stock by location, batch or package, inventory cost, or stock at a past date. For one row per product with reserved, available and incoming quantities use distru-report-inventory-valuation; for stock movements use distru-report-inventory-transaction-history. *Actual costs are the traced cost of the inputs that produced the stock; *Default values those inputs at their configured unit cost (the cost type's, else the product's). The four cost fields are null and left out of meta.columns when the caller cannot view costs. An inactive product's name ends in " (INACTIVE)". Slow: it rebuilds every stock row the company holds, so narrow by location or product and keep maxRowsLimit low. Quantities and money are numeric strings; expirationDate and harvestDate are YYYY-MM-DD. labTestingState is the package's current state, even for a past snapshotDatetime; null when the asset is not package-tracked. Returns 500 rows by default (maxRowsLimit, up to 5000). When meta.truncated is true more rows exist: repeat the call with the same filters, any date range made explicit so every page covers the same one, and cursor set to nextCursor — or narrow the filters when you need a summary rather than every row.