Search menus

distru-search-menusRead

Searches the wholesale menus the company publishes to its buyers: one row per menu with its names, visibility, public URL, ordering rules and AI order intake address.

Inputs

Every tool also takes the common inputs.

FieldTypeRequiredDescription
limitintegerNoDefault: 10
cursorstringNonextCursor of the previous call; keep the other arguments unchanged.
idsstring[]NoMenu IDs.
searchstringNoCase-insensitive substring of internal or buyer-facing external name. Ranks by name similarity; sortBy ignored.
statusenum
ACTIVEANYINACTIVE
NoDefault ACTIVE. An inactive menu serves nothing to buyers.
visibilityenum
PASSCODE_PROTECTEDPRIVATEPUBLIC
NoPUBLIC = anyone with the link; PRIVATE = only the company's own logged-in users; PASSCODE_PROTECTED = those users or anyone with the passcode.
sortByobjectNoDefault: most recently updated first. Ignored when search is set.
sortBy.directionenum
ASCDESC
Yes
sortBy.fieldenum
INSERTED_ATNAMEUPDATED_AT
YesNAME = internal menu name.

Output

Presence on a nested field assumes its parent exists.

FieldTypePresence
hasMorebooleanAlways
nextCursorstringCan be absent
totalCountintegerCan be absent
itemsobject[]Always
items[].idstringAlways
items[].namestringAlways
items[].externalNamestringAlways
items[].menuTitlestringCan be null
items[].activebooleanAlways
items[].discoverablebooleanAlways
items[].visibilityenum
PASSCODE_PROTECTEDPRIVATEPUBLIC
Always
items[].primaryUrlstringAlways
items[].sellByCaseOnlybooleanAlways
items[].showInventoryLevelsbooleanAlways
items[].allowSellingByPotencybooleanAlways
items[].minimumOrderLeadTimeDaysnumberAlways
items[].minimumOrderSubtotalstringCan be null
items[].aiOrderIntakeEmailstringCan be null
items[].insertedAtstringAlways
items[].updatedAtstringAlways
What the AI reads

Searches the wholesale menus the company publishes to its buyers: one row per menu with its names, visibility, public URL, ordering rules and AI order intake address. Use it to resolve a menuId for distru-search-menu-products or distru-search-menu-collections. aiOrderIntakeEmail is null unless AI order intake by email is switched on for the menu.