Skip to content

WarehouseTransferState ​

Type: Object

A warehouse transfer moving stock between locations

Fields ​

NameTypeArgsDescriptionDeprecated
approvedAtISO8601ISO-8601 timestamp the transfer was approved; null until it is approved.
approvedByUserIdUserIDTypeID of the user who approved the transfer (prefix "usr"); null until approved.
completedAtISO8601ISO-8601 timestamp the stock movement was completed; null until it is completed.
completedByUserIdUserIDTypeID of the user who completed the physical move (prefix "usr"); null until completed.
createdAtString!ISO-8601 timestamp the transfer record was created.
destinationLocationIdWarehouseLocationID!TypeID of the warehouse location stock is moved into (prefix "wlc"). Must differ from sourceLocationId.
idWarehouseTransferID!TypeID of this transfer (prefix "wtr").
notesStringFree-text note about the transfer; null when none was recorded.
quantityFloat!Amount of the stockable being moved, expressed in unit. Must be greater than zero.
reasonStockMovementReason!Why the stock is being moved (e.g. TRANSFERRED, ISSUED_TO_PRODUCTION, SCRAPPED).
referenceIdStringIdentifier of the originating document named by referenceType. Stored as an opaque string and not resolved by the server; null when the transfer stands alone.
referenceTypeStringKind of the originating document this transfer was raised against (e.g. a job or order). Free-form string, not a foreign key; null when the transfer stands alone.
requestedAtISO8601!ISO-8601 timestamp the transfer was requested. Defaults to the mutation time when not supplied.
requestedByUserIdUserIDTypeID of the user who raised the transfer (prefix "usr"); null when unattributed.
sourceLocationIdWarehouseLocationID!TypeID of the warehouse location stock is moved out of (prefix "wlc").
statusTransferStatus!Lifecycle status of the transfer. Starts at REQUESTED when not supplied on create; APPROVED / IN_PROGRESS / COMPLETED / CANCELLED are set by callers via update.
stockableStockable!The item being moved, resolved from (stockableType, stockableId) to the concrete catalog entity by the active vertical; falls back to a StockableMarker when the vertical cannot resolve it.
unitMeasurementUnit!Unit of measure the quantity is expressed in. Defaults to PC when not supplied.
updatedAtString!ISO-8601 timestamp the transfer record was last written by a mutation.

Connect machines, automate workflows, and build custom apps for print production.