Skip to content

CreateWarehouseTransferInput ​

Type: Input

Input for creating a warehouse transfer; the server allocates its id.

Fields ​

NameTypeDefaultDescription
approvedAtISO8601ISO-8601 timestamp the transfer was approved. Left null when omitted.
approvedByUserIdUserIDTypeID of the user who approved the transfer (prefix "usr"). Normally omitted on create.
completedAtISO8601ISO-8601 timestamp the stock movement completed. Left null when omitted.
completedByUserIdUserIDTypeID of the user who completed the move (prefix "usr"). Normally omitted on create.
destinationLocationIdWarehouseLocationID!TypeID of the warehouse location stock is moved into (prefix "wlc"). Must differ from sourceLocationId.
notesStringFree-text note about the transfer.
quantityFloat!Amount to move, 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 opaquely.
referenceTypeStringKind of the originating document this transfer is raised against (e.g. a job or order). Free-form string, not a foreign key.
requestedAtISO8601ISO-8601 timestamp the transfer was requested. Defaults to now when omitted.
requestedByUserIdUserIDTypeID of the user raising the transfer (prefix "usr").
sourceLocationIdWarehouseLocationID!TypeID of the warehouse location stock is moved out of (prefix "wlc").
statusTransferStatusInitial lifecycle status. Defaults to REQUESTED when omitted.
stockableIdString!Identifier of the item being moved, within the catalog named by stockableType.
stockableTypeStockableType!Kind of item being moved; discriminates which catalog stockableId points into.
unitMeasurementUnitUnit of measure for the quantity. Defaults to PC when omitted.

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