Search stock transfers | Distru Documentation

Searches stock transfers — moves of inventory between your locations — with their lines.

Inputs

Every tool also takes the common inputs.

Field	Type	Required	Description
limit	integer	No	Default: `10`
cursor	string	No	nextCursor of the previous call; keep the other arguments unchanged.
ids	string[]	No
search	string	No	Case-insensitive substring of the transfer number. Ranks by closeness to it; sortBy is ignored.
statuses	enum[] `CANCELEDCOMPLETEDTRANSIT`	No	TRANSIT: sent, not yet received; its stock is held aside at the source.
fromLocationIds	string[]	No	Resolve via distru-search-locations.
toLocationIds	string[]	No	Resolve via distru-search-locations.
productIds	string[]	No	Transfers with a line of these products. Resolve via distru-search-products.
batchIds	string[]	No	Transfers with a line of these batches. Resolve via distru-search-batches.
packageIds	string[]	No	Transfers with a line of these packages. Resolve via distru-search-packages.
transferDatetimeAfter	string	No	Inclusive. YYYY-MM-DD (start of day, company timezone) or ISO 8601 with a UTC offset.
transferDatetimeBefore	string	No	Inclusive. YYYY-MM-DD (end of day, company timezone) or ISO 8601 with a UTC offset.
completedAtAfter	string	No	Inclusive. YYYY-MM-DD (start of day, company timezone) or ISO 8601 with a UTC offset.
completedAtBefore	string	No	Inclusive. YYYY-MM-DD (end of day, company timezone) or ISO 8601 with a UTC offset.
customFields	object[]	No	Set one of contains, anyOf or onOrAfter/onOrBefore per entry. Records with no value for the field never match.
customFields[].customFieldId	string	Yes	Resolve via distru-search-custom-fields.
customFields[].contains	string	No	TEXT: case-insensitive substring.
customFields[].anyOf	string[]	No	DROPDOWN, CHECKBOX: any of these options, case-sensitive.
customFields[].onOrAfter	string	No	DATE: YYYY-MM-DD, company timezone.
customFields[].onOrBefore	string	No	DATE: YYYY-MM-DD, company timezone.
sortBy	object	No	Default UPDATED_AT DESC.
sortBy.direction	enum `ASCDESC`	Yes
sortBy.field	enum `COMPLETED_ATINITIATED_ATINSERTED_ATSTOCK_TRANSFER_NUMBERUPDATED_AT`	Yes	INITIATED_AT: transferDatetime. COMPLETED_AT: transfers not completed sort last either direction.

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
items	object[]	Always
items[].id	string	Always
items[].stockTransferNumber	string	Always
items[].status	enum `CANCELEDCOMPLETEDTRANSIT`	Always
items[].transferDatetime	string	Can be null
items[].completedAt	string	Can be null
items[].description	string	Can be null
items[].customFields	object[]	Always
items[].customFields[].customField	object	Always
items[].customFields[].customField.id	string	Always
items[].customFields[].customField.name	string	Always
items[].customFields[].customField.fieldType	enum `CHECKBOXDATEDROPDOWNTEXT`	Always
items[].customFields[].value	string	Can be null
items[].fromLocation	object	Can be null
items[].fromLocation.id	string	Always
items[].fromLocation.name	string	Always
items[].toLocation	object	Can be null
items[].toLocation.id	string	Always
items[].toLocation.name	string	Always
items[].items	object[]	Always
items[].items[].quantity	string	Can be null
items[].items[].product	object	Always
items[].items[].product.id	string	Always
items[].items[].product.name	string	Always
items[].items[].batch	object	Can be null
items[].items[].batch.id	string	Always
items[].items[].batch.name	string	Always
items[].items[].package	object	Can be null
items[].items[].package.id	string	Always
items[].items[].package.metrcLabel	string	Always

What the AI reads

Searches stock transfers — moves of inventory between your locations — with their lines. To move stock, use distru-move-stock. transferDatetime is the date the transfer shows; completedAt is when its stock arrived, null unless COMPLETED. An item's quantity is in the package's unit type on package lines, else in the product's unit type. batch is set only for batch-tracked products. fromLocation or toLocation is null on legacy transfers to or from a person instead of a location. Scoped to the transfers the caller's team may see.