Search inventory locations

distru-search-locationsRead

Searches your warehouses and rooms, with the license and Metrc room each maps to.

Inputs

Every tool also takes the common inputs.

FieldTypeRequiredDescription
limitintegerNoDefault: 10
cursorstringNonextCursor of the previous call; keep the other arguments unchanged.
complianceTypeenum
BIOTRACKMETRCNONE
NoOf the location's license. NONE: not tracked in Metrc.
idsstring[]No
licenseIdstringNoResolve via distru-search-licenses.
packageProductIdsstring[]NoLocations holding at least one non-inactive package of these products: where a product is stocked. Resolve via distru-search-products.
searchstringNoCase-insensitive substring of name. Ranked by name similarity; an explicit sortBy wins, similarity tie-breaks.
sortByobjectNoDefault UPDATED_AT DESC, or name similarity when search is set.
sortBy.directionenum
ASCDESC
Yes
sortBy.fieldenum
INSERTED_ATNAMEUPDATED_AT
Yes

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[].streetAddressstringAlways
items[].aptstringCan be null
items[].citystringAlways
items[].statestringAlways
items[].zipstringAlways
items[].countrystringAlways
items[].licenseobjectCan be null
items[].license.idstringAlways
items[].license.licenseNumberstringAlways
items[].metrcLocationobjectCan be null
items[].metrcLocation.idstringAlways
items[].metrcLocation.namestringAlways
What the AI reads

Searches the caller's company's inventory locations — the warehouses and rooms Distru stores stock and plants in — with the license each sits under and the Metrc room it maps to. For the Metrc rooms themselves, use distru-search-metrc-locations. For where a product is stocked, use packageProductIds.