Get a return | Distru Documentation

Gets one return by ID: header detail with quantities, status, total, company, location, owner and sales order.

Inputs

Every tool also takes the common inputs.

Field	Type	Required	Description
id	string	Yes	Resolve via distru-search-returns.
includeReturnItems	boolean	No

Output

Presence on a nested field assumes its parent exists.

Field	Type	Presence
return	object	Null or absent
return.id	string	Always
return.customFields	object[]	Always
return.customFields[].customField	object	Always
return.customFields[].customField.id	string	Always
return.customFields[].customField.name	string	Always
return.customFields[].customField.fieldType	enum `CHECKBOXDATEDROPDOWNTEXT`	Always
return.customFields[].value	string	Can be null
return.description	string	Can be null
return.invoiceNumbers	string[]	Always
return.orderQuantity	string	Can be null
return.qbCreditMemoId	string	Can be null
return.qbSyncStatus	enum `DELETED_IN_QBOERRORNOT_SYNCEDPARTIALLY_SYNCEDPENDINGSYNCED`	Can be null
return.returnDate	string	Can be null
return.returnNumber	string	Always
return.returnQuantity	string	Can be null
return.returnType	enum `FULL_RETURNPARTIAL_RETURN`	Can be null
return.status	enum `COMPLETEDPROCESSINGRECEIVEDSHIPPED`	Always
return.total	number	Always
return.company	object	Null or absent
return.company.id	string	Always
return.company.name	string	Null or absent
return.location	object	Can be null
return.location.id	string	Always
return.location.name	string	Always
return.owner	object	Can be null
return.owner.id	string	Always
return.owner.profile	object	Always
return.owner.profile.fullName	string	Always
return.salesOrder	object	Can be null
return.salesOrder.id	string	Always
return.salesOrder.orderNumber	string	Always
return.returnItems	object[]	Can be absent
return.returnItems[].id	string	Always
return.returnItems[].quantity	string	Always
return.returnItems[].waste	boolean	Always
return.returnItems[].orderItem	object	Can be null
return.returnItems[].orderItem.id	string	Always
return.returnItems[].orderItem.product	object	Always
return.returnItems[].orderItem.product.id	string	Always
return.returnItems[].orderItem.product.name	string	Always
return.returnItems[].product	object	Always
return.returnItems[].product.id	string	Always
return.returnItems[].product.name	string	Always

What the AI reads

Gets one return by ID: header detail with quantities, status, total, company, location, owner and sales order. Line items are left out unless you pass includeReturnItems. Use for a specific return after resolving its ID via distru-search-returns; to browse or search returns use distru-search-returns. Generic returns have no sales order — salesOrder, orderQuantity, returnQuantity and returnType are null and invoiceNumbers is empty. qbCreditMemoId is the QuickBooks credit memo the return itself synced as. qbSyncStatus is null unless the company's QuickBooks module is on and connected, and while the company syncs credits to QuickBooks: the credit the return created then syncs instead and carries the credit memo, so qbCreditMemoId is set only if the return synced before that. PENDING and ERROR are its latest sync's outcome and win over the rest; NOT_SYNCED = it has no QuickBooks credit memo. For why a sync failed, use distru-search-quickbooks-activities with returnIds. Null if no return matches the ID; a permission error if the caller can't view it.