Get a batch | Distru Documentation

Gets one inventory batch by ID: header detail with quantity, activeQuantityCost, dates, product, owner and primary test result.

Inputs

Every tool also takes the common inputs.

Field	Type	Required	Description
id	string	Yes	Resolve via distru-search-batches.
includeActiveQuantitiesByLocation	boolean	No	Active quantity per location, in the product's unit type.
includeActiveQuantityCostItems	boolean	No	activeQuantityCostItems: the costs that make up activeQuantityCost, oldest first; null when none is recorded or the caller cannot view cost details. Costs carry over from inputs, so recordedOn can be an upstream package, batch, product, harvest, plant or plant batch rather than this batch; MULTIPLE_PLANTS is a cost split over several plants or plant batches, NONE one tied to no inventory. quantity is the share that went into this batch, out of costQuantity; both in unitType. totalCost is quantity × costPerUnit; both null when no cost per unit is recorded or the caller cannot see it. costType is null for purchase costs and costs Distru records itself; origin.purchaseOrder and origin.assembly are null when team restrictions hide them.

Output

Presence on a nested field assumes its parent exists.

Field	Type	Presence
batch	object	Can be null
batch.id	string	Always
batch.customFields	object[]	Always
batch.customFields[].customField	object	Always
batch.customFields[].customField.id	string	Always
batch.customFields[].customField.name	string	Always
batch.customFields[].customField.fieldType	enum `CHECKBOXDATEDROPDOWNTEXT`	Always
batch.customFields[].value	string	Can be null
batch.name	string	Always
batch.batchNumber	string	Can be null
batch.description	string	Can be null
batch.thc	string	Can be null
batch.cbd	string	Can be null
batch.url	string	Always
batch.manufacturedDate	string	Always
batch.harvestDate	string	Can be null
batch.expirationDate	string	Can be null
batch.quantity	string	Always
batch.activeQuantityCost	string	Can be null
batch.product	object	Always
batch.product.id	string	Always
batch.product.name	string	Always
batch.owner	object	Can be null
batch.owner.id	string	Always
batch.owner.profile	object	Always
batch.owner.profile.fullName	string	Always
batch.primaryTestResult	object	Can be null
batch.primaryTestResult.id	string	Always
batch.primaryTestResult.name	string	Always
batch.primaryTestResult.thcPercentage	string	Can be null
batch.primaryTestResult.cbdPercentage	string	Can be null
batch.primaryTestResult.releaseDate	string	Can be null
batch.activeQuantitiesByLocation	object[]	Can be absent
batch.activeQuantitiesByLocation[].location	object	Always
batch.activeQuantitiesByLocation[].location.id	string	Always
batch.activeQuantitiesByLocation[].location.name	string	Always
batch.activeQuantitiesByLocation[].quantity	string	Always
batch.activeQuantityCostItems	object[]	Null or absent
batch.activeQuantityCostItems[].name	string	Always
batch.activeQuantityCostItems[].description	string	Can be null
batch.activeQuantityCostItems[].costType	object	Can be null
batch.activeQuantityCostItems[].costType.id	string	Always
batch.activeQuantityCostItems[].costType.name	string	Always
batch.activeQuantityCostItems[].createdBy	object	Can be null
batch.activeQuantityCostItems[].createdBy.id	string	Always
batch.activeQuantityCostItems[].createdBy.fullName	string	Always
batch.activeQuantityCostItems[].insertedAt	string	Always
batch.activeQuantityCostItems[].origin	object	Always
batch.activeQuantityCostItems[].origin.type	enum `ASSEMBLYBIOTRACK_ADJUSTMENTBIOTRACK_MANIFEST_RECEIVEDBREAKDOWNCOST_ENTRYMETRC_ADJUSTMENTMETRC_TRANSFER_RECEIVEDOTHERPACKAGE_IMPORTPLANT_BATCH_PACKAGINGPURCHASE_ORDERSTOCK_ADJUSTMENT`	Always
batch.activeQuantityCostItems[].origin.purchaseOrder	object	Can be null
batch.activeQuantityCostItems[].origin.purchaseOrder.id	string	Always
batch.activeQuantityCostItems[].origin.purchaseOrder.purchaseNumber	string	Always
batch.activeQuantityCostItems[].origin.assembly	object	Can be null
batch.activeQuantityCostItems[].origin.assembly.id	string	Always
batch.activeQuantityCostItems[].origin.assembly.number	string	Always
batch.activeQuantityCostItems[].origin.breakdown	object	Can be null
batch.activeQuantityCostItems[].origin.breakdown.breakdownNumber	string	Can be null
batch.activeQuantityCostItems[].recordedOn	object	Always
batch.activeQuantityCostItems[].recordedOn.type	enum `PACKAGEBATCHPRODUCTHARVESTPLANTPLANT_BATCHMULTIPLE_PLANTSNONE`	Always
batch.activeQuantityCostItems[].recordedOn.product	object	Can be null
batch.activeQuantityCostItems[].recordedOn.product.id	string	Always
batch.activeQuantityCostItems[].recordedOn.product.name	string	Always
batch.activeQuantityCostItems[].recordedOn.product.sku	string	Always
batch.activeQuantityCostItems[].recordedOn.package	object	Can be null
batch.activeQuantityCostItems[].recordedOn.package.id	string	Always
batch.activeQuantityCostItems[].recordedOn.package.metrcLabel	string	Always
batch.activeQuantityCostItems[].recordedOn.batch	object	Can be null
batch.activeQuantityCostItems[].recordedOn.batch.id	string	Always
batch.activeQuantityCostItems[].recordedOn.batch.name	string	Always
batch.activeQuantityCostItems[].recordedOn.harvest	object	Can be null
batch.activeQuantityCostItems[].recordedOn.harvest.name	string	Always
batch.activeQuantityCostItems[].recordedOn.plant	object	Can be null
batch.activeQuantityCostItems[].recordedOn.plant.label	string	Can be null
batch.activeQuantityCostItems[].recordedOn.plant.strainName	string	Can be null
batch.activeQuantityCostItems[].recordedOn.plantBatch	object	Can be null
batch.activeQuantityCostItems[].recordedOn.plantBatch.name	string	Always
batch.activeQuantityCostItems[].recordedOn.plantBatch.strainName	string	Can be null
batch.activeQuantityCostItems[].recordedOn.multiplePlants	object	Can be null
batch.activeQuantityCostItems[].recordedOn.multiplePlants.summary	string	Always
batch.activeQuantityCostItems[].recordedOn.multiplePlants.details	string	Always
batch.activeQuantityCostItems[].quantity	string	Always
batch.activeQuantityCostItems[].costQuantity	string	Always
batch.activeQuantityCostItems[].unitType	object	Always
batch.activeQuantityCostItems[].unitType.id	string	Always
batch.activeQuantityCostItems[].unitType.name	string	Always
batch.activeQuantityCostItems[].costPerUnit	string	Can be null
batch.activeQuantityCostItems[].totalCost	string	Can be null

What the AI reads

Gets one inventory batch by ID: header detail with quantity, activeQuantityCost, dates, product, owner and primary test result. Active quantity per location and the cost breakdown are left out unless you pass includeActiveQuantitiesByLocation or includeActiveQuantityCostItems. Use for a specific batch after resolving its ID via distru-search-batches; to browse or search batches use distru-search-batches; to change one, distru-mutate-batch. thc and cbd are free-text labels typed on the batch, not lab results; lab potency is on primaryTestResult. activeQuantityCost is the total cost of the active quantity, not per unit; null when none is recorded or the caller cannot view costs. The cost breakdown is null for batches of product-tracked and package-tracked products; use distru-get-product or distru-get-package for those. Null if no batch matches the ID; a permission error if the caller can't view it.