Appearance
UpdateWarehouseTransferInput
Type: Input
Partial update of a warehouse transfer: only the fields supplied are written, and null is indistinguishable from an omitted field.
Fields
| Name | Type | Default | Description |
|---|---|---|---|
| approvedAt | ISO8601 | ISO-8601 timestamp of approval; unchanged when omitted. | |
| approvedByUserId | UserID | TypeID of the approving user (prefix "usr"); unchanged when omitted. | |
| completedAt | ISO8601 | ISO-8601 timestamp of completion; unchanged when omitted. | |
| completedByUserId | UserID | TypeID of the completing user (prefix "usr"); unchanged when omitted. | |
| destinationLocationId | WarehouseLocationID | New destination warehouse location TypeID (prefix "wlc"); unchanged when omitted. The result must still differ from the source location. | |
| notes | String | New free-text note; unchanged when omitted (cannot be cleared through this input). | |
| quantity | Float | New amount to move, in unit; unchanged when omitted. Must be greater than zero. | |
| reason | StockMovementReason | New stock-movement reason; unchanged when omitted. | |
| referenceId | String | New originating-document identifier; unchanged when omitted. | |
| referenceType | String | New originating-document kind; unchanged when omitted. | |
| requestedAt | ISO8601 | New ISO-8601 requested timestamp; unchanged when omitted. | |
| requestedByUserId | UserID | TypeID of the requesting user (prefix "usr"); unchanged when omitted. | |
| sourceLocationId | WarehouseLocationID | New source warehouse location TypeID (prefix "wlc"); unchanged when omitted. | |
| status | TransferStatus | New lifecycle status (e.g. APPROVED, IN_PROGRESS, COMPLETED, CANCELLED); unchanged when omitted. Transitions are not restricted by the server. | |
| stockableId | String | New identifier of the item being moved; unchanged when omitted. | |
| stockableType | StockableType | New kind of item being moved; unchanged when omitted. | |
| unit | MeasurementUnit | New unit of measure for the quantity; unchanged when omitted. |