UpsertWarehouseTransferInput

Type: Input

Input for creating or wholly replacing a warehouse transfer. Every field is written as given, so omitted optional fields are cleared on an existing record.

Fields

Name	Type	Default	Description
approvedAt	ISO8601		ISO-8601 timestamp the transfer was approved. Left null when omitted.
approvedByUserId	UserID		TypeID of the user who approved the transfer (prefix "usr").
completedAt	ISO8601		ISO-8601 timestamp the stock movement completed. Left null when omitted.
completedByUserId	UserID		TypeID of the user who completed the physical move (prefix "usr").
destinationLocationId	WarehouseLocationID!		TypeID of the warehouse location stock is moved into (prefix "wlc"). Must differ from sourceLocationId.
id	WarehouseTransferID		TypeID of the transfer to overwrite (prefix "wtr"). Omit to create a new transfer; an id that matches no existing transfer is inserted under that id.
notes	String		Free-text note about the transfer.
quantity	Float!		Amount to move, expressed in unit. Must be greater than zero.
reason	StockMovementReason!		Why the stock is being moved (e.g. TRANSFERRED, ISSUED_TO_PRODUCTION, SCRAPPED).
referenceId	String		Identifier of the originating document named by referenceType; stored opaquely.
referenceType	String		Kind of the originating document this transfer is raised against (e.g. a job or order). Free-form string, not a foreign key.
requestedAt	ISO8601		ISO-8601 timestamp the transfer was requested. Defaults to now when omitted.
requestedByUserId	UserID		TypeID of the user raising the transfer (prefix "usr").
sourceLocationId	WarehouseLocationID!		TypeID of the warehouse location stock is moved out of (prefix "wlc").
status	TransferStatus		Lifecycle status to write. Defaults to REQUESTED when omitted.
stockableId	String!		Identifier of the item being moved, within the catalog named by stockableType.
stockableType	StockableType!		Kind of item being moved; discriminates which catalog stockableId points into.
unit	MeasurementUnit		Unit of measure for the quantity. Defaults to PC when omitted.