Get a Metrc manifest | Distru Documentation

Gets one Metrc transfer manifest by manifest number, with its recipients and packages.

Inputs

Every tool also takes the common inputs.

Field	Type	Required	Description
manifestNumber	string	Yes	e.g. 0000012345. Resolve via distru-search-metrc-manifests.
direction	enum `INCOMINGOUTGOING`	No	Side to read when the transfer is between two of the company's licenses. Defaults to OUTGOING, else INCOMING.
includeDeliveries	boolean	No	A package's status is SHIPPED until the recipient accepts, rejects or returns it; receivedQuantity and receivedUnitType null until received; package is the imported Distru package, null until imported or caller can't see it. package.hasCost true: it already has a cost, e.g. from a direct import, and importing the manifest as a purchase order adds another; package.quantityCost is that cost, the total for package.quantity (in the package's unit), not per unit, and null when the caller can't view costs. productMostRecentlyMappedToMetrcItem: the product its Metrc item was last mapped to on this license, null if never; distru-mutate-purchase-order uses package.product, else this, when a line omits productId.

Output

Presence on a nested field assumes its parent exists.

Field	Type	Presence
manifest	object	Can be null
manifest.manifestNumber	string	Always
manifest.shipperName	string	Always
manifest.shipperLicenseNumber	string	Always
manifest.transporterName	string	Can be null
manifest.transporterLicenseNumber	string	Can be null
manifest.recipients	object[]	Always
manifest.recipients[].name	string	Always
manifest.recipients[].licenseNumber	string	Always
manifest.shipmentTypeName	string	Can be null
manifest.packageCount	number	Always
manifest.importStatus	enum `IGNOREDIMPORTABLEIMPORTEDUNIMPORTED`	Always
manifest.isImportable	boolean	Always
manifest.importableDetails	string	Can be null
manifest.license	object	Always
manifest.license.id	string	Always
manifest.license.licenseNumber	string	Always
manifest.salesOrder	object	Can be null
manifest.salesOrder.id	string	Always
manifest.salesOrder.orderNumber	string	Always
manifest.salesOrder.customer	object	Can be null
manifest.salesOrder.customer.id	string	Always
manifest.salesOrder.customer.name	string	Null or absent
manifest.purchaseOrder	object	Can be null
manifest.purchaseOrder.id	string	Always
manifest.purchaseOrder.purchaseNumber	string	Always
manifest.createdDatetime	string	Always
manifest.lastModifiedDatetime	string	Always
manifest.receivedDatetime	string	Can be null
manifest.voided	boolean	Can be null
manifest.fetchedDatetime	string	Always
manifest.deliveries	object[]	Can be absent
manifest.deliveries[].recipientName	string	Always
manifest.deliveries[].recipientLicenseNumber	string	Always
manifest.deliveries[].actualDepartureDatetime	string	Can be null
manifest.deliveries[].actualArrivalDatetime	string	Can be null
manifest.deliveries[].receivedDatetime	string	Can be null
manifest.deliveries[].packages	object[]	Always
manifest.deliveries[].packages[].label	string	Always
manifest.deliveries[].packages[].itemName	string	Always
manifest.deliveries[].packages[].itemCategoryName	string	Always
manifest.deliveries[].packages[].status	enum `ACCEPTEDREJECTEDRETURNEDSHIPPED`	Always
manifest.deliveries[].packages[].isTestingSample	boolean	Always
manifest.deliveries[].packages[].shippedQuantity	string	Always
manifest.deliveries[].packages[].shippedUnitType	object	Can be null
manifest.deliveries[].packages[].shippedUnitType.id	string	Always
manifest.deliveries[].packages[].shippedUnitType.name	string	Always
manifest.deliveries[].packages[].receivedQuantity	string	Can be null
manifest.deliveries[].packages[].receivedUnitType	object	Can be null
manifest.deliveries[].packages[].receivedUnitType.id	string	Always
manifest.deliveries[].packages[].receivedUnitType.name	string	Always
manifest.deliveries[].packages[].wholesalePrice	string	Can be null
manifest.deliveries[].packages[].package	object	Can be null
manifest.deliveries[].packages[].package.id	string	Always
manifest.deliveries[].packages[].package.metrcLabel	string	Always
manifest.deliveries[].packages[].package.hasCost	boolean	Always
manifest.deliveries[].packages[].package.quantity	string	Always
manifest.deliveries[].packages[].package.quantityCost	string	Can be null
manifest.deliveries[].packages[].package.product	object	Always
manifest.deliveries[].packages[].package.product.id	string	Always
manifest.deliveries[].packages[].package.product.name	string	Always
manifest.deliveries[].packages[].productMostRecentlyMappedToMetrcItem	object	Can be null
manifest.deliveries[].packages[].productMostRecentlyMappedToMetrcItem.id	string	Always
manifest.deliveries[].packages[].productMostRecentlyMappedToMetrcItem.name	string	Always
manifest.direction	enum `INCOMINGOUTGOING`	Always

What the AI reads

Gets one Metrc transfer manifest by manifest number, as Distru last synced it from Metrc. recipients lists one entry per license an outgoing manifest delivers to; an incoming manifest's recipient is the company's own license. Pair salesOrder.customer with recipients to map customers to the Metrc licenses they were shipped to. fetchedDatetime is when Distru fetched this version from Metrc, not a Metrc time. importStatus is IMPORTED (as the salesOrder of an outgoing manifest, the purchaseOrder of an incoming one, or a stock transfer), IGNORED or UNIMPORTED, never IMPORTABLE; isImportable says whether Metrc's package states allow importing it. An outgoing manifest's receivedDatetime is when its last delivery was received. voided is true when the shipper canceled the manifest in Metrc, which is not a rejection by the recipient; a voided manifest is never received; null on manifests last synced before Metrc reported it. An internal transfer between two of the company's licenses appears as two manifests with the same manifestNumber, one per direction. Deliveries and their packages are left out unless you pass includeDeliveries. Use for a specific manifest; to browse manifests use distru-search-metrc-manifests, and for the manifest's PDF use distru-download-pdf. Returns null if no manifest matches the manifest number.