Search batches | Distru Documentation

Searches inventory batches — the lot a batch-tracked product's stock belongs to; only batches of batch-tracked products are returned.

Inputs

Every tool also takes the common inputs.

Field	Type	Required	Description
limit	integer	No	Default: `10`
cursor	string	No	nextCursor of the previous call; keep the other arguments unchanged.
ids	string[]	No	Batch IDs.
productIds	string[]	No	Resolve via distru-search-products.
productCategoryIds	string[]	No	Product category of the batches. 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 batches. 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 batches, 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).
productStatus	enum `ACTIVEANYINACTIVE`	No	The product's active state, not the batch's. Default ACTIVE.
search	string	No	Case-insensitive substring of batch name, batch number, product name or SKU. Ranks by batch-name similarity; sortBy ignored.
customFields	object[]	No	Set one of contains, anyOf or onOrAfter/onOrBefore per entry. Records with no value for the field never match.
customFields[].customFieldId	string	Yes	Resolve via distru-search-custom-fields.
customFields[].contains	string	No	TEXT: case-insensitive substring.
customFields[].anyOf	string[]	No	DROPDOWN, CHECKBOX: any of these options, case-sensitive.
customFields[].onOrAfter	string	No	DATE: YYYY-MM-DD, company timezone.
customFields[].onOrBefore	string	No	DATE: YYYY-MM-DD, company timezone.
thcPercentageTotal	object	No	Filter batches by primaryTestResult.thcPercentageTotal, the total THC percentage on their primary test result, e.g. {min: 28} for 28% and up. Records without a primary test result, or whose total THC is not recorded, never match.
thcPercentageTotal.min	string or number	No	Lowest total THC percentage to keep, inclusive.
thcPercentageTotal.max	string or number	No	Highest total THC percentage to keep, inclusive.
sortBy	object	No	Default: most recently updated first. Ignored when search is set.
sortBy.direction	enum `ASCDESC`	Yes
sortBy.field	enum `BATCH_NUMBERINSERTED_ATUPDATED_AT`	Yes	BATCH_NUMBER puts batches without one last, both directions.

Output

Presence on a nested field assumes its parent exists.

Field	Type	Presence
hasMore	boolean	Always
nextCursor	string	Can be absent
totalCount	integer	Can be absent
items	object[]	Always
items[].id	string	Always
items[].customFields	object[]	Always
items[].customFields[].customField	object	Always
items[].customFields[].customField.id	string	Always
items[].customFields[].customField.name	string	Always
items[].customFields[].customField.fieldType	enum `CHECKBOXDATEDROPDOWNTEXT`	Always
items[].customFields[].value	string	Can be null
items[].name	string	Always
items[].batchNumber	string	Can be null
items[].manufacturedDate	string	Always
items[].harvestDate	string	Can be null
items[].expirationDate	string	Can be null
items[].quantity	string	Always
items[].activeQuantityCost	string	Can be null
items[].product	object	Always
items[].product.id	string	Always
items[].product.name	string	Always
items[].product.sku	string	Always
items[].product.inactive	boolean	Always
items[].product.unitType	object	Always
items[].product.unitType.id	string	Always
items[].product.unitType.name	string	Always
items[].activeQuantitiesByLocation	object[]	Always
items[].activeQuantitiesByLocation[].location	object	Always
items[].activeQuantitiesByLocation[].location.id	string	Always
items[].activeQuantitiesByLocation[].location.name	string	Always
items[].activeQuantitiesByLocation[].quantity	string	Always
items[].primaryTestResult	object	Can be null
items[].primaryTestResult.id	string	Always
items[].primaryTestResult.name	string	Always
items[].primaryTestResult.labName	string	Can be null
items[].primaryTestResult.releaseDate	string	Can be null
items[].primaryTestResult.thcPercentage	string	Can be null
items[].primaryTestResult.thcPercentageTotal	string	Can be null
items[].primaryTestResult.cbdPercentage	string	Can be null
items[].primaryTestResult.cbdPercentageTotal	string	Can be null

What the AI reads

Searches inventory batches — the lot a batch-tracked product's stock belongs to; only batches of batch-tracked products are returned. One row per batch with its dates, active quantity across every inventory source and per location, active quantity cost, primary test result potency and product. Use it to resolve a batchId, e.g. for a batch-tracked line on distru-create-assembly; for package-tracked stock use distru-search-packages, and for one batch's cost breakdown use distru-get-batch. Deleted batches are never returned. To narrow by what kind of product, filter on the product's category, subcategory, tags, vendor, brand or group directly instead of resolving productIds first. Quantities are in the product's unit type. activeQuantityCost is the total cost of the active quantity, not per unit; null when none is recorded or the caller cannot view costs.