ReturnItem
A return item represents a line item in an order that is to be returned. It includes details related to the return and the reason behind it.
Constructors
constructor
**new ReturnItem**()
A return item represents a line item in an order that is to be returned. It includes details related to the return and the reason behind it.
Properties
is_requestedbooleanRequiredWhether the Return Item was requested initially or received unexpectedly in the warehouse.
Default: true
The details of the line item in the original order to be returned.
item_idstringRequiredThe ID of the Line Item that the Return Item references.
metadataRecord<string, unknown>RequiredAn optional key-value map with additional details
notestringRequiredAn optional note with additional details about the Return.
quantitynumberRequiredThe quantity of the Line Item to be returned.
The details of the reason for returning the item.
reason_idstringRequiredThe ID of the reason for returning the item.
received_quantitynumberRequiredThe quantity that was received in the warehouse.
requested_quantitynumberRequiredThe quantity that was originally requested to be returned.
return_idstringRequiredThe ID of the Return that the Return Item belongs to.
Details of the Return that the Return Item belongs to.
Was this section helpful?