Get a product | Distru Documentation

Gets one product with its pricing, costs, stock levels, potency, strain, brand, vendor and menus.

Inputs

Every tool also takes the common inputs.

Field	Type	Required	Description
id	string	Yes	Resolve via distru-search-products.
includeImages	boolean	No
includeTags	boolean	No
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 product; 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 product, 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.
includeBillOfMaterials	boolean	No	What one unit of this product takes; null when none. inputs[].quantity is per unit of this product, in inputs[].unitType. An input is a fixed product or anyProductMatching: any product meeting every listed condition (any entry within a list; absent key sets no condition) whose unit type shares unitType's category (count, volume or weight), its quantity converted to unitType. unitType null only when the input's unit type was deleted; each matching product's quantity is then in its own unit type. costs[].quantity is the cost type's quantity per unit of this product.

Output

Presence on a nested field assumes its parent exists.

Field	Type	Presence
product	object	Null or absent
product.id	string	Always
product.customFields	object[]	Always
product.customFields[].customField	object	Always
product.customFields[].customField.id	string	Always
product.customFields[].customField.name	string	Always
product.customFields[].customField.fieldType	enum `CHECKBOXDATEDROPDOWNTEXT`	Always
product.customFields[].value	string	Can be null
product.name	string	Always
product.externalName	string	Can be null
product.sku	string	Always
product.upc	string	Can be null
product.description	string	Can be null
product.descriptionMarkdown	string	Can be null
product.isInactive	boolean	Always
product.isFeatured	boolean	Always
product.maxMenuBuyerOrderQuantity	number	Can be null
product.inventoryTrackingMethod	enum `BATCHPACKAGEPRODUCT`	Always
product.unitCost	string	Can be null
product.activeQuantityCost	string	Can be null
product.unitPrice	string	Always
product.wholesaleUnitPrice	string	Can be null
product.msrp	string	Can be null
product.unitsPerCase	string	Can be null
product.totalThc	string	Can be null
product.totalCbd	string	Can be null
product.totalCannabinoidUnit	enum `MGPERCENT`	Can be null
product.quantityActive	string	Always
product.quantityActivePassedTesting	string	Can be null
product.quantityAvailable	string	Always
product.quantityIncoming	string	Always
product.quantityReserved	string	Always
product.quantityPendingOutput	string	Always
product.quantityAvailableThresholdMin	string	Can be null
product.quantityAvailableThresholdMax	string	Can be null
product.unitNetWeight	string	Can be null
product.unitServingSize	string	Can be null
product.unitNetWeightAndServingSizeUnitType	object	Can be null
product.unitNetWeightAndServingSizeUnitType.id	string	Always
product.unitNetWeightAndServingSizeUnitType.name	string	Always
product.grossWeight	string	Can be null
product.grossWeightUnitType	object	Can be null
product.grossWeightUnitType.id	string	Always
product.grossWeightUnitType.name	string	Always
product.menuVisibility	enum `DO_NOT_INCLUDEINCLUDE_IN_ALLINCLUDE_IN_SELECT`	Always
product.menus	object[]	Always
product.menus[].id	string	Always
product.menus[].name	string	Always
product.thumbnailImageUrl	string	Always
product.url	string	Always
product.insertedAt	string	Always
product.updatedAt	string	Always
product.category	object	Can be null
product.category.id	string	Always
product.category.name	string	Always
product.subcategory	object	Can be null
product.subcategory.id	string	Always
product.subcategory.name	string	Always
product.group	object	Can be null
product.group.id	string	Always
product.group.name	string	Always
product.unitType	object	Always
product.unitType.id	string	Always
product.unitType.name	string	Always
product.strain	object	Can be null
product.strain.id	string	Always
product.strain.name	string	Always
product.brand	object	Null or absent
product.brand.id	string	Always
product.brand.name	string	Null or absent
product.vendor	object	Null or absent
product.vendor.id	string	Always
product.vendor.name	string	Null or absent
product.owner	object	Can be null
product.owner.id	string	Always
product.owner.profile	object	Always
product.owner.profile.fullName	string	Always
product.quickbooksSalesItem	object	Can be null
product.quickbooksSalesItem.id	string	Always
product.quickbooksSalesItem.name	string	Always
product.quickbooksPurchaseItem	object	Can be null
product.quickbooksPurchaseItem.id	string	Always
product.quickbooksPurchaseItem.name	string	Always
product.images	object[]	Can be absent
product.images[].id	string	Always
product.images[].name	string	Always
product.images[].rank	number	Always
product.images[].urlOriginal	string	Always
product.tags	object[]	Can be absent
product.tags[].id	string	Always
product.tags[].name	string	Always
product.billOfMaterials	object	Null or absent
product.billOfMaterials.name	string	Always
product.billOfMaterials.description	string	Can be null
product.billOfMaterials.inputs	object[]	Always
product.billOfMaterials.inputs[].quantity	string	Always
product.billOfMaterials.inputs[].unitType	object	Can be null
product.billOfMaterials.inputs[].unitType.id	string	Always
product.billOfMaterials.inputs[].unitType.name	string	Always
product.billOfMaterials.inputs[].product	object	Can be null
product.billOfMaterials.inputs[].product.id	string	Always
product.billOfMaterials.inputs[].product.name	string	Always
product.billOfMaterials.inputs[].product.sku	string	Can be null
product.billOfMaterials.inputs[].anyProductMatching	object	Can be null
product.billOfMaterials.inputs[].anyProductMatching.oneOfProductCategories	object[]	Can be absent
product.billOfMaterials.inputs[].anyProductMatching.oneOfProductCategories[].id	string	Always
product.billOfMaterials.inputs[].anyProductMatching.oneOfProductCategories[].name	string	Always
product.billOfMaterials.inputs[].anyProductMatching.oneOfProductSubcategories	object[]	Can be absent
product.billOfMaterials.inputs[].anyProductMatching.oneOfProductSubcategories[].id	string	Always
product.billOfMaterials.inputs[].anyProductMatching.oneOfProductSubcategories[].name	string	Always
product.billOfMaterials.inputs[].anyProductMatching.oneOfProductGroups	object[]	Can be absent
product.billOfMaterials.inputs[].anyProductMatching.oneOfProductGroups[].id	string	Always
product.billOfMaterials.inputs[].anyProductMatching.oneOfProductGroups[].name	string	Always
product.billOfMaterials.inputs[].anyProductMatching.oneOfProductStrains	object[]	Can be absent
product.billOfMaterials.inputs[].anyProductMatching.oneOfProductStrains[].id	string	Always
product.billOfMaterials.inputs[].anyProductMatching.oneOfProductStrains[].name	string	Always
product.billOfMaterials.inputs[].anyProductMatching.oneOfProductTags	object[]	Can be absent
product.billOfMaterials.inputs[].anyProductMatching.oneOfProductTags[].id	string	Always
product.billOfMaterials.inputs[].anyProductMatching.oneOfProductTags[].name	string	Always
product.billOfMaterials.costs	object[]	Always
product.billOfMaterials.costs[].costType	object	Always
product.billOfMaterials.costs[].costType.id	string	Always
product.billOfMaterials.costs[].costType.name	string	Always
product.billOfMaterials.costs[].quantity	string	Always
product.billOfMaterials.costs[].description	string	Can be null
product.activeQuantitiesByLocation	object[]	Can be absent
product.activeQuantitiesByLocation[].location	object	Always
product.activeQuantitiesByLocation[].location.id	string	Always
product.activeQuantitiesByLocation[].location.name	string	Always
product.activeQuantitiesByLocation[].quantity	string	Always
product.activeQuantityCostItems	object[]	Null or absent
product.activeQuantityCostItems[].name	string	Always
product.activeQuantityCostItems[].description	string	Can be null
product.activeQuantityCostItems[].costType	object	Can be null
product.activeQuantityCostItems[].costType.id	string	Always
product.activeQuantityCostItems[].costType.name	string	Always
product.activeQuantityCostItems[].createdBy	object	Can be null
product.activeQuantityCostItems[].createdBy.id	string	Always
product.activeQuantityCostItems[].createdBy.fullName	string	Always
product.activeQuantityCostItems[].insertedAt	string	Always
product.activeQuantityCostItems[].origin	object	Always
product.activeQuantityCostItems[].origin.type	enum `ASSEMBLYBIOTRACK_ADJUSTMENTBIOTRACK_MANIFEST_RECEIVEDBREAKDOWNCOST_ENTRYMETRC_ADJUSTMENTMETRC_TRANSFER_RECEIVEDOTHERPACKAGE_IMPORTPLANT_BATCH_PACKAGINGPURCHASE_ORDERSTOCK_ADJUSTMENT`	Always
product.activeQuantityCostItems[].origin.purchaseOrder	object	Can be null
product.activeQuantityCostItems[].origin.purchaseOrder.id	string	Always
product.activeQuantityCostItems[].origin.purchaseOrder.purchaseNumber	string	Always
product.activeQuantityCostItems[].origin.assembly	object	Can be null
product.activeQuantityCostItems[].origin.assembly.id	string	Always
product.activeQuantityCostItems[].origin.assembly.number	string	Always
product.activeQuantityCostItems[].origin.breakdown	object	Can be null
product.activeQuantityCostItems[].origin.breakdown.breakdownNumber	string	Can be null
product.activeQuantityCostItems[].recordedOn	object	Always
product.activeQuantityCostItems[].recordedOn.type	enum `PACKAGEBATCHPRODUCTHARVESTPLANTPLANT_BATCHMULTIPLE_PLANTSNONE`	Always
product.activeQuantityCostItems[].recordedOn.product	object	Can be null
product.activeQuantityCostItems[].recordedOn.product.id	string	Always
product.activeQuantityCostItems[].recordedOn.product.name	string	Always
product.activeQuantityCostItems[].recordedOn.product.sku	string	Always
product.activeQuantityCostItems[].recordedOn.package	object	Can be null
product.activeQuantityCostItems[].recordedOn.package.id	string	Always
product.activeQuantityCostItems[].recordedOn.package.metrcLabel	string	Always
product.activeQuantityCostItems[].recordedOn.batch	object	Can be null
product.activeQuantityCostItems[].recordedOn.batch.id	string	Always
product.activeQuantityCostItems[].recordedOn.batch.name	string	Always
product.activeQuantityCostItems[].recordedOn.harvest	object	Can be null
product.activeQuantityCostItems[].recordedOn.harvest.name	string	Always
product.activeQuantityCostItems[].recordedOn.plant	object	Can be null
product.activeQuantityCostItems[].recordedOn.plant.label	string	Can be null
product.activeQuantityCostItems[].recordedOn.plant.strainName	string	Can be null
product.activeQuantityCostItems[].recordedOn.plantBatch	object	Can be null
product.activeQuantityCostItems[].recordedOn.plantBatch.name	string	Always
product.activeQuantityCostItems[].recordedOn.plantBatch.strainName	string	Can be null
product.activeQuantityCostItems[].recordedOn.multiplePlants	object	Can be null
product.activeQuantityCostItems[].recordedOn.multiplePlants.summary	string	Always
product.activeQuantityCostItems[].recordedOn.multiplePlants.details	string	Always
product.activeQuantityCostItems[].quantity	string	Always
product.activeQuantityCostItems[].costQuantity	string	Always
product.activeQuantityCostItems[].unitType	object	Always
product.activeQuantityCostItems[].unitType.id	string	Always
product.activeQuantityCostItems[].unitType.name	string	Always
product.activeQuantityCostItems[].costPerUnit	string	Can be null
product.activeQuantityCostItems[].totalCost	string	Can be null

What the AI reads

Gets one product by ID with full detail: pricing, costs, inventory quantities and stock levels, potency, weights, classification, unit type, strain, brand, vendor, owner and menu placement. Images, tags, active quantity per location, the cost breakdown and the bill of materials are left out unless you pass includeImages, includeTags, includeActiveQuantitiesByLocation, includeActiveQuantityCostItems or includeBillOfMaterials. Use for a specific product after resolving its ID via distru-search-products; to browse or search products use distru-search-products. unitCost is the default cost per unit; activeQuantityCost is the total cost of the active quantity, not per unit, null when none is recorded or the caller cannot view costs. quantityActivePassedTesting is the part of the active quantity in packages whose lab test passed; null for batch- and product-tracked products. The cost breakdown is null for batch-tracked and package-tracked products; use distru-get-batch or distru-get-package for those. quantityAvailableThresholdMin/Max are the minimum and maximum stock levels, null when unset; an available quantity below the minimum is low inventory. unitNetWeight and unitServingSize are per unit, in unitNetWeightAndServingSizeUnitType. vendor is the company the product is purchased from. menus lists every menu the product is on; menuVisibility INCLUDE_IN_ALL can still be off some menus. quickbooksSalesItem / quickbooksPurchaseItem null = no QuickBooks item of its own: its lines sync through the company's default item. Null if no product matches the ID; a permission error if the caller can't view it.