Get a package | Distru Documentation

Gets one package with its compliance status, lab results, potency, quantities, location and costs.

Inputs

Every tool also takes the common inputs.

Field	Type	Required	Description
id	string	Yes	Resolve via distru-search-packages.
includeQuantityCostItems	boolean	No	quantityCostItems: the costs that make up quantityCost, 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 package; 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 package, 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
package	object	Can be null
package.id	string	Always
package.customFields	object[]	Always
package.customFields[].customField	object	Always
package.customFields[].customField.id	string	Always
package.customFields[].customField.name	string	Always
package.customFields[].customField.fieldType	enum `CHECKBOXDATEDROPDOWNTEXT`	Always
package.customFields[].value	string	Can be null
package.metrcLabel	string	Always
package.complianceType	enum `BIOTRACKMETRCNONE`	Always
package.metrcId	number	Can be null
package.complianceProductName	string	Can be null
package.complianceStrainName	string	Can be null
package.distruStatus	enum `ACTIVEASSEMBLINGDESTROYEDDISCONTINUEDFINISHEDON_HOLDRETURNINGSELLINGSOLDTRANSFERRED`	Always
package.isActive	boolean	Always
package.metrcStatus	enum `ACTIVEDISCONTINUEDFINISHEDONHOLDTRANSFERRED`	Can be null
package.metrcProductionBatchNumber	string	Can be null
package.metrcSourcePackageLabels	string[]	Can be null
package.syncing	boolean	Always
package.syncingReason	enum `ASSEMBLY_INPUTASSEMBLY_OUTPUTCOMPLIANCE_TRANSFERCREATE_HARVEST_PACKAGECREATE_PLANT_BATCHES_FROM_PACKAGEDESTROY_PACKAGEFINISH_PACKAGESALES_ORDERSTOCK_ADJUSTMENTUNFINISH_PACKAGEUNKNOWN`	Can be null
package.batchNumber	string	Can be null
package.description	string	Can be null
package.compliancePackagedDate	string	Can be null
package.harvestDate	string	Can be null
package.expirationDate	string	Can be null
package.finishedAt	string	Can be null
package.insertedAt	string	Always
package.updatedAt	string	Always
package.isTestSample	boolean	Always
package.isTradeSample	boolean	Always
package.isFinishedGood	boolean	Can be null
package.labTestingState	enum `FAILEDNOT_TESTEDPASSEDPENDING`	Always
package.labTestingStateDate	string	Can be null
package.quantity	string	Always
package.quantityActive	string	Always
package.quantityAssembling	string	Always
package.quantityInMetrc	string	Can be null
package.quantityCost	string	Can be null
package.unitType	object	Always
package.unitType.id	string	Always
package.unitType.name	string	Always
package.product	object	Always
package.product.id	string	Always
package.product.name	string	Always
package.product.sku	string	Always
package.batch	object	Always
package.batch.id	string	Always
package.batch.name	string	Always
package.location	object	Always
package.location.id	string	Always
package.location.name	string	Always
package.license	object	Always
package.license.id	string	Always
package.license.licenseNumber	string	Always
package.activeSalesOrder	object	Can be null
package.activeSalesOrder.id	string	Always
package.activeSalesOrder.orderNumber	string	Always
package.primaryTestResult	object	Can be null
package.primaryTestResult.id	string	Always
package.primaryTestResult.name	string	Always
package.primaryTestResult.labName	string	Can be null
package.primaryTestResult.releaseDate	string	Can be null
package.primaryTestResult.thcPercentage	string	Can be null
package.primaryTestResult.thcPercentageTotal	string	Can be null
package.primaryTestResult.cbdPercentage	string	Can be null
package.primaryTestResult.cbdPercentageTotal	string	Can be null
package.quantityCostItems	object[]	Null or absent
package.quantityCostItems[].name	string	Always
package.quantityCostItems[].description	string	Can be null
package.quantityCostItems[].costType	object	Can be null
package.quantityCostItems[].costType.id	string	Always
package.quantityCostItems[].costType.name	string	Always
package.quantityCostItems[].createdBy	object	Can be null
package.quantityCostItems[].createdBy.id	string	Always
package.quantityCostItems[].createdBy.fullName	string	Always
package.quantityCostItems[].insertedAt	string	Always
package.quantityCostItems[].origin	object	Always
package.quantityCostItems[].origin.type	enum `ASSEMBLYBIOTRACK_ADJUSTMENTBIOTRACK_MANIFEST_RECEIVEDBREAKDOWNCOST_ENTRYMETRC_ADJUSTMENTMETRC_TRANSFER_RECEIVEDOTHERPACKAGE_IMPORTPLANT_BATCH_PACKAGINGPURCHASE_ORDERSTOCK_ADJUSTMENT`	Always
package.quantityCostItems[].origin.purchaseOrder	object	Can be null
package.quantityCostItems[].origin.purchaseOrder.id	string	Always
package.quantityCostItems[].origin.purchaseOrder.purchaseNumber	string	Always
package.quantityCostItems[].origin.assembly	object	Can be null
package.quantityCostItems[].origin.assembly.id	string	Always
package.quantityCostItems[].origin.assembly.number	string	Always
package.quantityCostItems[].origin.breakdown	object	Can be null
package.quantityCostItems[].origin.breakdown.breakdownNumber	string	Can be null
package.quantityCostItems[].recordedOn	object	Always
package.quantityCostItems[].recordedOn.type	enum `PACKAGEBATCHPRODUCTHARVESTPLANTPLANT_BATCHMULTIPLE_PLANTSNONE`	Always
package.quantityCostItems[].recordedOn.product	object	Can be null
package.quantityCostItems[].recordedOn.product.id	string	Always
package.quantityCostItems[].recordedOn.product.name	string	Always
package.quantityCostItems[].recordedOn.product.sku	string	Always
package.quantityCostItems[].recordedOn.package	object	Can be null
package.quantityCostItems[].recordedOn.package.id	string	Always
package.quantityCostItems[].recordedOn.package.metrcLabel	string	Always
package.quantityCostItems[].recordedOn.batch	object	Can be null
package.quantityCostItems[].recordedOn.batch.id	string	Always
package.quantityCostItems[].recordedOn.batch.name	string	Always
package.quantityCostItems[].recordedOn.harvest	object	Can be null
package.quantityCostItems[].recordedOn.harvest.name	string	Always
package.quantityCostItems[].recordedOn.plant	object	Can be null
package.quantityCostItems[].recordedOn.plant.label	string	Can be null
package.quantityCostItems[].recordedOn.plant.strainName	string	Can be null
package.quantityCostItems[].recordedOn.plantBatch	object	Can be null
package.quantityCostItems[].recordedOn.plantBatch.name	string	Always
package.quantityCostItems[].recordedOn.plantBatch.strainName	string	Can be null
package.quantityCostItems[].recordedOn.multiplePlants	object	Can be null
package.quantityCostItems[].recordedOn.multiplePlants.summary	string	Always
package.quantityCostItems[].recordedOn.multiplePlants.details	string	Always
package.quantityCostItems[].quantity	string	Always
package.quantityCostItems[].costQuantity	string	Always
package.quantityCostItems[].unitType	object	Always
package.quantityCostItems[].unitType.id	string	Always
package.quantityCostItems[].unitType.name	string	Always
package.quantityCostItems[].costPerUnit	string	Can be null
package.quantityCostItems[].totalCost	string	Can be null

What the AI reads

Gets one inventory package by ID — a physical container of stock, tagged where the product is package-tracked: compliance identity and status, Distru status, lab testing and potency, quantities and quantity cost, and the product, batch, location and license it belongs to. primaryTestResult includes results inherited from source packages, so skip distru-search-test-results for those. isFinishedGood is Metrc's finished-good flag, null where the package's license can't set it. The cost breakdown is left out unless you pass includeQuantityCostItems. To browse or search packages use distru-search-packages. Quantities are in the package's unit type: quantity is what the package holds (for a transferred package, what it held when transferred); quantityAssembling is held by pending assemblies; quantityActive is the rest, 0 while the package's stock is selling, returning, sold or transferred. quantityActive does not deduct a sales order until it starts selling the package: activeSalesOrder is the non-canceled, non-merged sales order the package is on, null when there is none or the caller cannot see it. quantityCost is the total cost of the package's current quantity whatever its status, not per unit; null when none is recorded, the caller cannot view costs or quantity is 0 (no cost items either); past movement costs: distru-report-inventory-transaction-history (packageId). metrcId, metrcStatus, metrcProductionBatchNumber, metrcSourcePackageLabels (tags Metrc says it was made from; look them up via distru-search-packages search) and quantityInMetrc (Metrc's quantity at last sync, in Metrc's unit, may be negative) are null outside Metrc. syncing is true while a change is being sent to Metrc. isActive false = inactivated in Distru, still active in Metrc. batchNumber is the package's own free-text grouping label, not the linked Distru batch — which batch a package belongs to is batch.name. A null expirationDate means expiry isn't tracked. Null if no package matches the ID; a permission error if the caller can't view it.