Skip to main content
Skip to main content

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

return_idstringRequired
The ID of the Return that the Return Item belongs to.
item_idstringRequired
The ID of the Line Item that the Return Item references.
return_orderReturnRequired
Details of the Return that the Return Item belongs to.
itemLineItemRequired
The details of the line item in the original order to be returned.
quantitynumberRequired
The quantity of the Line Item to be returned.
is_requestedbooleanRequired
Whether the Return Item was requested initially or received unexpectedly in the warehouse.

Default: true

requested_quantitynumberRequired
The quantity that was originally requested to be returned.
received_quantitynumberRequired
The quantity that was received in the warehouse.
reason_idstringRequired
The ID of the reason for returning the item.
reasonReturnReasonRequired
The details of the reason for returning the item.
notestringRequired
An optional note with additional details about the Return.
metadataRecord<string, unknown>Required
An optional key-value map with additional details
Was this section helpful?