Get a menu's settings | Distru Documentation

Gets one of your company's menus, inactive ones included, with everything distru-mutate-menu writes but the passcode.

Inputs

Every tool also takes the common inputs.

Field	Type	Required	Description
id	string	Yes	Resolve via distru-search-menus.
includeCollections	boolean	No	Adds collections (custom ones, in display order, with the filters that pick their products) and officialCollections (Distru's, with any custom name).

Output

Presence on a nested field assumes its parent exists.

Field	Type	Presence
menu	object	Can be null
menu.id	string	Always
menu.name	string	Always
menu.externalName	string	Always
menu.primaryUrl	string	Always
menu.owner	object	Can be null
menu.owner.id	string	Always
menu.owner.fullName	string	Always
menu.active	boolean	Always
menu.visibility	enum `PASSCODE_PROTECTEDPRIVATEPUBLIC`	Always
menu.discoverable	boolean	Always
menu.allowPartnerOrders	boolean	Always
menu.locations	object[]	Always
menu.locations[].id	string	Always
menu.locations[].name	string	Always
menu.minimumOrderSubtotal	string	Can be null
menu.minimumOrderLeadTimeDays	number	Always
menu.availableDeliveryDays	string[]	Always
menu.buyerCanSelectDeliveryDate	boolean	Always
menu.sellByCaseOnly	boolean	Always
menu.allowCustomersToOverOrder	boolean	Always
menu.defaultOrderStatus	string	Always
menu.buyerDefaultOrderOwnerMode	enum `CUSTOMERS_COMPANY_OWNERDEFAULTSPECIFIC_USER`	Always
menu.buyerDefaultOrderOwner	object	Can be null
menu.buyerDefaultOrderOwner.id	string	Always
menu.buyerDefaultOrderOwner.fullName	string	Always
menu.sellerDefaultOrderOwnerMode	enum `CUSTOMERS_COMPANY_OWNERDEFAULTSALES_REPSPECIFIC_USER`	Always
menu.sellerDefaultOrderOwner	object	Can be null
menu.sellerDefaultOrderOwner.id	string	Always
menu.sellerDefaultOrderOwner.fullName	string	Always
menu.allowSalesRepsToOverrideNetTerms	boolean	Always
menu.autoCreateInvoiceForSalesRepOrders	boolean	Always
menu.showInventoryLevels	boolean	Always
menu.showProductsWithNoInventoryMode	enum `DO_NOT_SHOWSHOW_AND_ALLOW_TO_ORDERSHOW_AS_SOLD_OUT`	Always
menu.hidePricesMode	string	Always
menu.hideOriginalPriceWhenPriceTierApplied	boolean	Always
menu.allowSellingByPotency	boolean	Always
menu.potencyOfficialProductCategoryIds	enum[] `CAPSULESCLONESCONCENTRATESEDIBLESFLOWERMERCHOTHERPREROLLSTINCTURESTOPICALSVAPES`	Always
menu.showCoa	boolean	Always
menu.showExpirationDate	boolean	Always
menu.showPackageDate	boolean	Always
menu.showTac	boolean	Always
menu.showTotalCbd	boolean	Always
menu.allowBuyersToRequestTradeSamples	boolean	Always
menu.restrictTradeSampleRequestToProductsInCart	boolean	Always
menu.sendInternalOrderNotifications	boolean	Always
menu.internalOrderNotificationRecipients	object[]	Always
menu.internalOrderNotificationRecipients[].id	string	Always
menu.internalOrderNotificationRecipients[].fullName	string	Always
menu.collections	object[]	Can be absent
menu.collections[].id	string	Always
menu.collections[].name	string	Always
menu.collections[].isHidden	boolean	Always
menu.collections[].onlyFeaturedProducts	boolean	Always
menu.collections[].officialProductCategoryIds	enum[] `CAPSULESCLONESCONCENTRATESEDIBLESFLOWERMERCHOTHERPREROLLSTINCTURESTOPICALSVAPES`	Always
menu.collections[].productCategories	object[]	Always
menu.collections[].productCategories[].id	string	Always
menu.collections[].productCategories[].name	string	Always
menu.collections[].productSubcategories	object[]	Always
menu.collections[].productSubcategories[].id	string	Always
menu.collections[].productSubcategories[].name	string	Always
menu.collections[].productGroups	object[]	Always
menu.collections[].productGroups[].id	string	Always
menu.collections[].productGroups[].name	string	Always
menu.collections[].brands	object[]	Always
menu.collections[].brands[].id	string	Always
menu.collections[].brands[].name	string	Always
menu.collections[].strains	object[]	Always
menu.collections[].strains[].id	string	Always
menu.collections[].strains[].name	string	Always
menu.collections[].strainTypes	enum[] `HIGH_CBDHYBRIDINDICAINDICA_DOMINANTSATIVASATIVA_DOMINANT`	Always
menu.collections[].thcRange	object	Can be null
menu.collections[].thcRange.min	string	Can be absent
menu.collections[].thcRange.max	string	Can be absent
menu.collections[].thcRange.unit	string	Always
menu.officialCollections	object[]	Can be absent
menu.officialCollections[].officialCollectionName	string	Always
menu.officialCollections[].customName	string	Can be null

What the AI reads

Gets one of your company's menus, inactive ones included, with everything distru-mutate-menu writes but the passcode. Not its products (distru-search-products menuIds, or distru-search-menu-products as buyers see them) or other menus (distru-search-menus). potencyOfficialProductCategoryIds are official category IDs, as category.officialProductCategory.id on distru-search-menu-products. Null if no menu matches the ID; a permission error if the caller can't view it.