The sales return row object

AttributeDescription
idUnique identifier for the sales return row
sales_return_idReference to the parent sales return
variant_idProduct variant being returned
fulfillment_row_idReference to the original fulfillment row
from GET /sales_orders/id/returnable_items
sales_order_row_idReference to the original sales order row
quantityNumber of items being returned
net_price_per_unitOriginal amount paid per unit by the customer after discounts
reason_idReference to the return reason
restock_location_idLocation where items will be restocked
batch_transactionsBatch entries of traceability. Deprecated: use traceability.
traceabilityBatch, serial number and bin location assignments of the row. They can be changed with PATCH /sales_return_rows/{id} until the return is restocked, and restocking puts the stock back with them. An entry with neither a batch nor a serial number is quantity returned untraced.
created_atThe timestamp when row was created.
updated_atThe timestamp when row was last updated.

The traceability object

AttributeDescription
batch_idID of the returned batch. Null for serial-tracked or untraced quantity.
serial_number_idID of the returned serial number. Null for batch-tracked or untraced quantity.
bin_location_idID of the bin location at the restock location that the stock goes back to. Null when no bin is assigned.
quantityThe timestamp when return record was last updated.

Returnable traceability object

AttributeDescription
batch_idID of a batch shipped on the sales order row and not taken by another return. Null for serial numbers and untraced quantity.
serial_number_idID of a serial number shipped on the sales order row and not taken by another return. Null for batches and untraced quantity.
quantityDecimal string quantity the row can still take back. Always "1" for a serial number.
batchThe batch, as in the batch object. Null when the entry has no batch.
serial_numberThe serial number: id and serial_number. Null when the entry has no serial number.

The batch transaction object

Deprecated: use the traceability relation instead, which also covers bin and serial numbers.

AttributeDescription
batch_idID of the returned batch.
quantityQuantity returned in this batch.

Unassigned batch transactions object

Deprecated: use the returnable traceability endpoint instead, which also covers serial numbers.

AttributeDescription
batch_idID of a batch shipped on the sales order row and not yet returned. Null for the quantity shipped without a batch.
quantityDecimal string quantity of the batch the row can still take back.
batch_numberBatch number. Unbatched for the quantity shipped without a batch.
batch_created_dateCreation date of the batch. Not present on the Unbatched entry.
batch_expiration_dateExpiration date of the batch. Not present on the Unbatched entry.
barcodeBarcode record of the batch, with the barcode in internalBarcode. Not present when the batch has no barcode or on the Unbatched entry.