Search a menu's products | Distru Documentation

Searches the products on one menu, with quantity available, sold-out status and THC as that menu shows them.

Inputs

Every tool also takes the common inputs.

Field	Type	Required	Description
menuId	string	Yes	Resolve via distru-search-menus.
search	string	No	Matches name, SKU, strain, brand, category, subcategory, strain type, category type, and product group (if the menu allows group filtering). Ranks by relevance; sortBy ignored.
productIds	string[]	No	Resolve via distru-search-products.
officialProductCategories	enum[] `CAPSULESCLONESCONCENTRATESEDIBLESFLOWERMERCHOTHERPREROLLSTINCTURESTOPICALSVAPES`	No	Category type. See productCategoryIds.
productCategoryIds	string[]	No	Narrows only its own category type: FLOWER + EDIBLES + a Gummies category returns all flower but only gummies. Works alone, also for a category with no category type. From includeFilterOptions (only categories with a category type). Resolve via distru-search-lookups (type PRODUCT_CATEGORY).
productSubcategoryIds	string[]	No	Narrows only its own category, as productCategoryIds narrows a category type. Works alone. From includeFilterOptions. Resolve via distru-search-lookups (type PRODUCT_CATEGORY, each row's subcategories).
strainTypes	enum[] `HIGH_CBDHYBRIDINDICAINDICA_DOMINANTSATIVASATIVA_DOMINANT`	No
strainIds	string[]	No	From includeFilterOptions or a row's strain.
brandIds	string[]	No	Brand, itself a company. From includeFilterOptions or a row's brand, or resolve via distru-search-companies.
productGroupIds	string[]	No	From includeFilterOptions. Resolve via distru-search-lookups (type PRODUCT_GROUP).
includeFilterOptions	boolean	No	Adds filterOptions: the values of each filter this menu shows, keyed by the param they go in; category types nest their categories and subcategories. They span the whole menu (or productIds), not search or the other filters. Slow on large menus.
sortBy	object	No	Default: most recently updated on the menu first. Ignored when search is set; to find by name, use search.
sortBy.direction	enum `ASCDESC`	Yes
sortBy.field	enum `INSERTED_ATPRODUCT_NAMEUPDATED_AT`	Yes	INSERTED_AT = added to the menu; UPDATED_AT = menu listing last changed; PRODUCT_NAME = buyer-facing name.
limit	integer	No	Default: `10`
cursor	string	No	nextCursor of the previous call; keep the other arguments unchanged.

Output

Presence on a nested field assumes its parent exists.

Field	Type	Presence
hasMore	boolean	Always
nextCursor	string	Can be absent
totalCount	integer	Can be absent
note	string	Can be absent
filterOptions	object	Can be absent
filterOptions.officialProductCategories	object[]	Can be absent
filterOptions.officialProductCategories[].id	string	Always
filterOptions.officialProductCategories[].name	string	Always
filterOptions.officialProductCategories[].productCategoryIds	object[]	Can be absent
filterOptions.officialProductCategories[].productCategoryIds[].id	string	Always
filterOptions.officialProductCategories[].productCategoryIds[].name	string	Always
filterOptions.officialProductCategories[].productCategoryIds[].productSubcategoryIds	object[]	Can be absent
filterOptions.officialProductCategories[].productCategoryIds[].productSubcategoryIds[].id	string	Always
filterOptions.officialProductCategories[].productCategoryIds[].productSubcategoryIds[].name	string	Always
filterOptions.officialProductCategories[].productSubcategoryIds	object[]	Can be absent
filterOptions.officialProductCategories[].productSubcategoryIds[].id	string	Always
filterOptions.officialProductCategories[].productSubcategoryIds[].name	string	Always
filterOptions.strainTypes	object[]	Can be absent
filterOptions.strainTypes[].id	string	Always
filterOptions.strainTypes[].name	string	Always
filterOptions.strainIds	object[]	Can be absent
filterOptions.strainIds[].id	string	Always
filterOptions.strainIds[].name	string	Always
filterOptions.brandIds	object[]	Can be absent
filterOptions.brandIds[].id	string	Always
filterOptions.brandIds[].name	string	Always
filterOptions.productGroupIds	object[]	Can be absent
filterOptions.productGroupIds[].id	string	Always
filterOptions.productGroupIds[].name	string	Always
items	object[]	Always
items[].id	string	Always
items[].name	string	Always
items[].unitsPerCase	string	Can be null
items[].maxMenuBuyerOrderQuantity	number	Can be null
items[].totalThc	string	Can be null
items[].totalCannabinoidUnit	enum `MGPERCENT`	Can be null
items[].brand	object	Can be null
items[].brand.id	string	Always
items[].brand.name	string	Always
items[].category	object	Always
items[].category.id	string	Always
items[].category.name	string	Always
items[].category.officialProductCategory	object	Can be null
items[].category.officialProductCategory.id	string	Always
items[].subcategory	object	Can be null
items[].subcategory.id	string	Always
items[].subcategory.name	string	Always
items[].strain	object	Can be null
items[].strain.id	string	Always
items[].strain.name	string	Always
items[].strain.strainType	enum `HIGH_CBDHYBRIDINDICAINDICA_DOMINANTSATIVASATIVA_DOMINANT`	Can be null
items[].unitType	object	Always
items[].unitType.id	string	Always
items[].unitType.name	string	Always
items[].unitType.category	enum `COUNTVOLUMEWEIGHT`	Can be null
items[].unitType.qtyPerSiUnit	string	Can be null
items[].quantityAvailable	string	Can be null
items[].soldOut	boolean	Always
items[].unitPrice	string	Can be null
items[].thcPercentageTotalLevels	object[]	Always
items[].thcPercentageTotalLevels[].thcPercentageTotal	string	Always
items[].thcPercentageTotalLevels[].quantityAvailable	string	Can be null
items[].thcPercentageTotalRange	object	Can be null
items[].thcPercentageTotalRange.max	string	Always
items[].thcPercentageTotalRange.min	string	Always

What the AI reads

Searches the products on one menu, with quantity available, sold-out status and THC as that menu shows them. Use it instead of distru-search-products when finding products to add to an order — it only shows products available on the menu. For which products are placed on a menu, including ones buyers don't see, use distru-search-products menuIds / notOnMenuIds. A filter given several values matches any of them. A product's unitPrice is the base price per unit (a case costs unitPrice × unitsPerCase), before price-tier discounts, so it may not be what a buyer pays; null when the menu hides prices from the caller. For the tiers that can apply, use distru-search-price-tiers with menuIds and validAt: a tier with no customer condition applies to every buyer, while customerIds and customerGroupIds only find tiers that name them. A product's thcPercentageTotalRange spans the THC % of its in-stock lab results; thcPercentageTotalLevels lists the THC % a buyer must pick from and is empty unless the menu sells the product by potency.