The stock transfer object

AttributeDescription
idUnique identifier for the object.
stock_transfer_numberA string used to identify the stock transfer.
source_location_idID the location from which you are transferring the items.
target_location_idID the location to which you are transferring the items.
transfer_dateThe timestamp of transferring the items from one location to another. ISO 8601 format with time and timezone must be used.
additional_infoA string attached to the object to add any internal comments, links to external files, additional instructions, etc.
stock_transfer_rowsAn array of stock transfer rows.
created_atThe timestamp when the stock transfer was created.
updated_atThe timestamp when the stock transfer was last updated.

The stock transfer row object

AttributeDescription
variant_idID of product or material variant added to the stock transfer row.
quantityThe quantity transferred from one location to another.
traceabilityAn array of allocation entries describing how the transferred quantity is split across batches, serial numbers, and bin locations. Preferred over batch_transactions; when both are supplied, traceability takes precedence.
traceability.batch_idID of the batch the allocation is drawn from. Null when the allocation is untraced or serial-tracked. Mutually exclusive with serial_number_id.
traceability.serial_number_idID of the serial number for the allocation. Null when the allocation is untraced or batch-tracked. Mutually exclusive with batch_id.
traceability.bin_location_idID of the bin location the stock is drawn from / moved to. Null when not bin-tracked.
traceability.quantityDecimal string quantity for the allocation entry. Serial entries are implicitly "1".
batch_transactionsDeprecated — use traceability instead. An array of batch transactions and their quantities. You can transfer stock for the same item from multiple batches. When traceability is supplied it takes precedence over batch_transactions.
batch_transaction.batch_idID of the batch for the transferred item.
batch_transactions.quantityThe quantity transferred from a particular batch.