Get an assembly | Distru Documentation

Gets one assembly by ID: header detail with kind, status, cost, license and owner.

Inputs

Every tool also takes the common inputs.

Field	Type	Required	Description
id	string	Yes	Resolve via distru-search-assemblies.
includeAssemblyLines	boolean	No	Output lines, each with the input lines consumed into it.
includeOutputCostItems	boolean	No	costItems on each output line; returns the output lines even without includeAssemblyLines, not their inputs. costItems: the costs that make up the output's cost, 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 output; 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 output, 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.
includeOutputAddedCosts	boolean	No	addedCosts on each output line: costs added in this assembly, e.g. labor or packaging. Returns the output lines even without includeAssemblyLines, not their inputs. quantity is in unitType (the cost type's, else the output product's). costPerUnit and totalCost null when no cost per unit recorded or caller can't see it. Once the output is completed these are also in its costItems with origin.type ASSEMBLY; never add the two.

Output

Presence on a nested field assumes its parent exists.

Field	Type	Presence
assembly	object	Can be null
assembly.id	string	Always
assembly.customFields	object[]	Always
assembly.customFields[].customField	object	Always
assembly.customFields[].customField.id	string	Always
assembly.customFields[].customField.name	string	Always
assembly.customFields[].customField.fieldType	enum `CHECKBOXDATEDROPDOWNTEXT`	Always
assembly.customFields[].value	string	Can be null
assembly.number	string	Always
assembly.status	enum `COMPLETEDPENDING`	Always
assembly.complianceType	enum `BIOTRACKMETRCNONE`	Always
assembly.description	string	Can be null
assembly.cost	string	Can be null
assembly.estimatedStartDate	string	Can be null
assembly.estimatedWorkMinutes	number	Can be null
assembly.completedAt	string	Can be null
assembly.createdDate	string	Always
assembly.updatedDate	string	Always
assembly.license	object	Can be null
assembly.license.id	string	Always
assembly.license.licenseNumber	string	Always
assembly.owner	object	Can be null
assembly.owner.id	string	Always
assembly.owner.email	string	Always
assembly.owner.profile	object	Always
assembly.owner.profile.fullName	string	Always
assembly.kind	enum `MANUFACTURINGPACKAGE_SPLITTEST_SAMPLESALES_ORDER_REPACKAGE`	Always
assembly.assemblyOutputs	object[]	Can be absent
assembly.assemblyOutputs[].id	string	Always
assembly.assemblyOutputs[].status	enum `COMPLETEDPENDING`	Always
assembly.assemblyOutputs[].quantity	string	Always
assembly.assemblyOutputs[].metrcLabel	string	Can be null
assembly.assemblyOutputs[].batchNumber	string	Can be null
assembly.assemblyOutputs[].expirationDate	string	Can be null
assembly.assemblyOutputs[].packageDate	string	Can be null
assembly.assemblyOutputs[].productionBatchNumber	string	Can be null
assembly.assemblyOutputs[].product	object	Always
assembly.assemblyOutputs[].product.id	string	Always
assembly.assemblyOutputs[].product.name	string	Always
assembly.assemblyOutputs[].product.unitType	object	Always
assembly.assemblyOutputs[].product.unitType.id	string	Always
assembly.assemblyOutputs[].product.unitType.name	string	Always
assembly.assemblyOutputs[].batch	object	Can be null
assembly.assemblyOutputs[].batch.id	string	Always
assembly.assemblyOutputs[].batch.name	string	Always
assembly.assemblyOutputs[].location	object	Can be null
assembly.assemblyOutputs[].location.id	string	Always
assembly.assemblyOutputs[].location.name	string	Always
assembly.assemblyOutputs[].package	object	Can be null
assembly.assemblyOutputs[].package.id	string	Always
assembly.assemblyOutputs[].package.metrcLabel	string	Always
assembly.assemblyOutputs[].packageUnitType	object	Can be null
assembly.assemblyOutputs[].packageUnitType.id	string	Always
assembly.assemblyOutputs[].packageUnitType.name	string	Always
assembly.assemblyOutputs[].complianceQuantity	string	Can be null
assembly.assemblyOutputs[].assemblyInputs	object[]	Can be absent
assembly.assemblyOutputs[].assemblyInputs[].id	string	Always
assembly.assemblyOutputs[].assemblyInputs[].status	enum `COMPLETEDDRAFTPENDING`	Always
assembly.assemblyOutputs[].assemblyInputs[].quantity	string	Always
assembly.assemblyOutputs[].assemblyInputs[].product	object	Always
assembly.assemblyOutputs[].assemblyInputs[].product.id	string	Always
assembly.assemblyOutputs[].assemblyInputs[].product.name	string	Always
assembly.assemblyOutputs[].assemblyInputs[].product.unitType	object	Always
assembly.assemblyOutputs[].assemblyInputs[].product.unitType.id	string	Always
assembly.assemblyOutputs[].assemblyInputs[].product.unitType.name	string	Always
assembly.assemblyOutputs[].assemblyInputs[].batch	object	Can be null
assembly.assemblyOutputs[].assemblyInputs[].batch.id	string	Always
assembly.assemblyOutputs[].assemblyInputs[].batch.name	string	Always
assembly.assemblyOutputs[].assemblyInputs[].location	object	Can be null
assembly.assemblyOutputs[].assemblyInputs[].location.id	string	Always
assembly.assemblyOutputs[].assemblyInputs[].location.name	string	Always
assembly.assemblyOutputs[].assemblyInputs[].package	object	Can be null
assembly.assemblyOutputs[].assemblyInputs[].package.id	string	Always
assembly.assemblyOutputs[].assemblyInputs[].package.metrcLabel	string	Always
assembly.assemblyOutputs[].assemblyInputs[].package.unitType	object	Always
assembly.assemblyOutputs[].assemblyInputs[].package.unitType.id	string	Always
assembly.assemblyOutputs[].assemblyInputs[].package.unitType.name	string	Always
assembly.assemblyOutputs[].assemblyInputs[].complianceQuantity	string	Can be null
assembly.assemblyOutputs[].costItems	object[]	Null or absent
assembly.assemblyOutputs[].costItems[].name	string	Always
assembly.assemblyOutputs[].costItems[].description	string	Can be null
assembly.assemblyOutputs[].costItems[].costType	object	Can be null
assembly.assemblyOutputs[].costItems[].costType.id	string	Always
assembly.assemblyOutputs[].costItems[].costType.name	string	Always
assembly.assemblyOutputs[].costItems[].createdBy	object	Can be null
assembly.assemblyOutputs[].costItems[].createdBy.id	string	Always
assembly.assemblyOutputs[].costItems[].createdBy.fullName	string	Always
assembly.assemblyOutputs[].costItems[].insertedAt	string	Always
assembly.assemblyOutputs[].costItems[].origin	object	Always
assembly.assemblyOutputs[].costItems[].origin.type	enum `ASSEMBLYBIOTRACK_ADJUSTMENTBIOTRACK_MANIFEST_RECEIVEDBREAKDOWNCOST_ENTRYMETRC_ADJUSTMENTMETRC_TRANSFER_RECEIVEDOTHERPACKAGE_IMPORTPLANT_BATCH_PACKAGINGPURCHASE_ORDERSTOCK_ADJUSTMENT`	Always
assembly.assemblyOutputs[].costItems[].origin.purchaseOrder	object	Can be null
assembly.assemblyOutputs[].costItems[].origin.purchaseOrder.id	string	Always
assembly.assemblyOutputs[].costItems[].origin.purchaseOrder.purchaseNumber	string	Always
assembly.assemblyOutputs[].costItems[].origin.assembly	object	Can be null
assembly.assemblyOutputs[].costItems[].origin.assembly.id	string	Always
assembly.assemblyOutputs[].costItems[].origin.assembly.number	string	Always
assembly.assemblyOutputs[].costItems[].origin.breakdown	object	Can be null
assembly.assemblyOutputs[].costItems[].origin.breakdown.breakdownNumber	string	Can be null
assembly.assemblyOutputs[].costItems[].recordedOn	object	Always
assembly.assemblyOutputs[].costItems[].recordedOn.type	enum `PACKAGEBATCHPRODUCTHARVESTPLANTPLANT_BATCHMULTIPLE_PLANTSNONE`	Always
assembly.assemblyOutputs[].costItems[].recordedOn.product	object	Can be null
assembly.assemblyOutputs[].costItems[].recordedOn.product.id	string	Always
assembly.assemblyOutputs[].costItems[].recordedOn.product.name	string	Always
assembly.assemblyOutputs[].costItems[].recordedOn.product.sku	string	Always
assembly.assemblyOutputs[].costItems[].recordedOn.package	object	Can be null
assembly.assemblyOutputs[].costItems[].recordedOn.package.id	string	Always
assembly.assemblyOutputs[].costItems[].recordedOn.package.metrcLabel	string	Always
assembly.assemblyOutputs[].costItems[].recordedOn.batch	object	Can be null
assembly.assemblyOutputs[].costItems[].recordedOn.batch.id	string	Always
assembly.assemblyOutputs[].costItems[].recordedOn.batch.name	string	Always
assembly.assemblyOutputs[].costItems[].recordedOn.harvest	object	Can be null
assembly.assemblyOutputs[].costItems[].recordedOn.harvest.name	string	Always
assembly.assemblyOutputs[].costItems[].recordedOn.plant	object	Can be null
assembly.assemblyOutputs[].costItems[].recordedOn.plant.label	string	Can be null
assembly.assemblyOutputs[].costItems[].recordedOn.plant.strainName	string	Can be null
assembly.assemblyOutputs[].costItems[].recordedOn.plantBatch	object	Can be null
assembly.assemblyOutputs[].costItems[].recordedOn.plantBatch.name	string	Always
assembly.assemblyOutputs[].costItems[].recordedOn.plantBatch.strainName	string	Can be null
assembly.assemblyOutputs[].costItems[].recordedOn.multiplePlants	object	Can be null
assembly.assemblyOutputs[].costItems[].recordedOn.multiplePlants.summary	string	Always
assembly.assemblyOutputs[].costItems[].recordedOn.multiplePlants.details	string	Always
assembly.assemblyOutputs[].costItems[].quantity	string	Always
assembly.assemblyOutputs[].costItems[].costQuantity	string	Always
assembly.assemblyOutputs[].costItems[].unitType	object	Always
assembly.assemblyOutputs[].costItems[].unitType.id	string	Always
assembly.assemblyOutputs[].costItems[].unitType.name	string	Always
assembly.assemblyOutputs[].costItems[].costPerUnit	string	Can be null
assembly.assemblyOutputs[].costItems[].totalCost	string	Can be null
assembly.assemblyOutputs[].addedCosts	object[]	Can be absent
assembly.assemblyOutputs[].addedCosts[].name	string	Always
assembly.assemblyOutputs[].addedCosts[].description	string	Can be null
assembly.assemblyOutputs[].addedCosts[].costType	object	Can be null
assembly.assemblyOutputs[].addedCosts[].costType.id	string	Always
assembly.assemblyOutputs[].addedCosts[].costType.name	string	Always
assembly.assemblyOutputs[].addedCosts[].insertedAt	string	Always
assembly.assemblyOutputs[].addedCosts[].quantity	string	Always
assembly.assemblyOutputs[].addedCosts[].unitType	object	Always
assembly.assemblyOutputs[].addedCosts[].unitType.id	string	Always
assembly.assemblyOutputs[].addedCosts[].unitType.name	string	Always
assembly.assemblyOutputs[].addedCosts[].costPerUnit	string	Can be null
assembly.assemblyOutputs[].addedCosts[].totalCost	string	Can be null

What the AI reads

Gets one assembly by ID: header detail with kind, status, cost, license and owner. Output lines and the input lines consumed into them are left out unless you pass includeAssemblyLines; includeOutputCostItems and includeOutputAddedCosts add each output's cost breakdown and the costs added on it in this assembly. Use for a specific assembly after resolving its ID via distru-search-assemblies; to browse assemblies use distru-search-assemblies. cost is null when the caller lacks permission to view costs. Line quantity is in the product's unit type; complianceQuantity is the quantity in the package's unit type (input package.unitType, output packageUnitType) as tracked in Metrc, null when complianceType is NONE. An output's batchNumber is the batchNumber its package gets (for a batch-tracked product, its batch's), not the linked Distru batch, whose name is batch.name. Null if no assembly matches the ID; a permission error if the caller can't view it.