← All types
In Input object

UpsertWarehouseTransferInput

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

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.

TypeID of the warehouse location stock is moved out of (prefix "wlc").

TypeID of the warehouse location stock is moved into (prefix "wlc"). Must differ from sourceLocationId.

Kind of item being moved; discriminates which catalog stockableId points into.

Possible values (7)
OPERATION_PRODUCT

Durable operation output identity. Actual stock receipts remain gated pending the material receipt service.

SUBSTRATE

Substrate / paper / media.

COMPONENT

A component used in production.

FINISHED_GOODS

Finished goods.

TOOL

Tooling.

INK

Ink.

CONSUMABLE

Generic consumable.

Identifier of the item being moved, within the catalog named by stockableType.

quantity

Float!Required

Amount to move, expressed in unit. Must be greater than zero.

Unit of measure for the quantity. Defaults to PC when omitted.

Possible values (15)
CLICK

A billing counter rather than a physical measure: one metered page charged under a cost-per-click press or copier contract.

CM

Centimetres — metric length, a hundredth of a metre.

FT

Feet — imperial length, twelve inches.

G

Grams — metric mass, for light items stocked by weight.

IMPRESSION

A production counter rather than a physical measure: one pass of one sheet through a press. Distinct from SHEET, since a sheet printed on both sides can cost two impressions.

IN

Inches — imperial length, the unit paper sizes are quoted in outside metric markets.

KG

Kilograms — metric mass, the usual unit for reel and other bulk substrate stock.

LB

Pounds — imperial mass, roughly 0.45 kg.

M

Metres — metric length, the usual unit for material bought by the running metre such as a reel or a roll of laminate.

MM

Millimetres — metric length, a thousandth of a metre, and the granularity trim sizes and other sheet dimensions are normally given in.

OZ

Ounces — imperial mass, a sixteenth of a pound.

PC

Pieces: a plain count of discrete items, carrying no dimension at all. The unit stock and transfer quantities fall back to when none is given.

PT

Points — the typographic length unit of one seventy-second of an inch, used for type sizes and rule weights rather than for stock quantities.

REPEAT

One printed repeat of a web: a cut-off in web offset, a repeat in flexo and labels. What a roll press counts when it produces signatures.

SHEET

A count of substrate sheets, the usual unit for sheet-fed stock. Counts the physical sheets held or moved, not the press passes over them (see IMPRESSION).

Why the stock is being moved (e.g. TRANSFERRED, ISSUED_TO_PRODUCTION, SCRAPPED).

Possible values (8)
RECEIVED

Stock entering the business from outside it — a supplier delivery booked in at goods-in. The tenant's total on hand goes up.

TRANSFERRED

A purely internal relocation between two of the tenant's own locations, such as putaway from goods-in into a bin. The total on hand is unchanged.

ISSUED_TO_PRODUCTION

Material leaving the warehouse to be consumed by a job or work centre, typically into a PRODUCTION location; it is no longer available to pick.

RETURNED_FROM_PRODUCTION

The reverse of ISSUED_TO_PRODUCTION: unused material coming back off the shop floor and becoming pickable stock again.

SHIPPED

Stock leaving the business towards a customer as part of a dispatch. The tenant's total on hand goes down.

ADJUSTED

A bookkeeping correction that brings the recorded quantity into line with a physical count. Nothing was physically moved.

SCRAPPED

Stock deliberately destroyed or written off — obsolete, expired or surplus — as opposed to DAMAGED, which records loss discovered in handling.

DAMAGED

Stock written off because it was found broken or spoiled in handling or storage, as opposed to SCRAPPED, which is a deliberate disposal.

notes

StringOptional

Free-text note about the transfer.

Kind of the originating document this transfer is raised against (e.g. a job or order). Free-form string, not a foreign key.

Identifier of the originating document named by referenceType; stored opaquely.

Lifecycle status to write. Defaults to REQUESTED when omitted.

Possible values (5)
REQUESTED

Raised but not yet authorised; the status a new transfer takes when create supplies none. The intended next steps are APPROVED or CANCELLED.

APPROVED

Authorised to go ahead — approvedByUserId and approvedAt record who and when — but no stock has been touched yet. The intended next steps are IN_PROGRESS or CANCELLED.

IN_PROGRESS

The physical move is under way: stock has left the source location but has not been booked in at the destination. The intended next steps are COMPLETED or CANCELLED.

COMPLETED

The stock has arrived at the destination, with completedByUserId and completedAt recorded. Terminal: the lifecycle defines no move out of it.

CANCELLED

The transfer was abandoned from REQUESTED, APPROVED or IN_PROGRESS and will not be carried out. Terminal, and the way a transfer closes without ever reaching COMPLETED.

TypeID of the user raising the transfer (prefix "usr").

TypeID of the user who approved the transfer (prefix "usr").

TypeID of the user who completed the physical move (prefix "usr").

ISO-8601 timestamp the transfer was requested. Defaults to now when omitted.

ISO-8601 timestamp the transfer was approved. Left null when omitted.

ISO-8601 timestamp the stock movement completed. Left null when omitted.

Referenced by (1)
Exact type SDL
"""
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.
"""
input UpsertWarehouseTransferInput {
  """
  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.
  """
  id: WarehouseTransferID
  """TypeID of the warehouse location stock is moved out of (prefix "wlc")."""
  sourceLocationId: WarehouseLocationID!
  """
  TypeID of the warehouse location stock is moved into (prefix "wlc"). Must differ from sourceLocationId.
  """
  destinationLocationId: WarehouseLocationID!
  """
  Kind of item being moved; discriminates which catalog stockableId points into.
  """
  stockableType: StockableType!
  """
  Identifier of the item being moved, within the catalog named by stockableType.
  """
  stockableId: String!
  """Amount to move, expressed in `unit`. Must be greater than zero."""
  quantity: Float!
  """Unit of measure for the quantity. Defaults to PC when omitted."""
  unit: MeasurementUnit
  """
  Why the stock is being moved (e.g. TRANSFERRED, ISSUED_TO_PRODUCTION, SCRAPPED).
  """
  reason: StockMovementReason!
  """Free-text note about the transfer."""
  notes: String
  """
  Kind of the originating document this transfer is raised against (e.g. a job or order). Free-form string, not a foreign key.
  """
  referenceType: String
  """
  Identifier of the originating document named by referenceType; stored opaquely.
  """
  referenceId: String
  """Lifecycle status to write. Defaults to REQUESTED when omitted."""
  status: TransferStatus
  """TypeID of the user raising the transfer (prefix "usr")."""
  requestedByUserId: UserID
  """TypeID of the user who approved the transfer (prefix "usr")."""
  approvedByUserId: UserID
  """TypeID of the user who completed the physical move (prefix "usr")."""
  completedByUserId: UserID
  """
  ISO-8601 timestamp the transfer was requested. Defaults to now when omitted.
  """
  requestedAt: ISO8601
  """ISO-8601 timestamp the transfer was approved. Left null when omitted."""
  approvedAt: ISO8601
  """
  ISO-8601 timestamp the stock movement completed. Left null when omitted.
  """
  completedAt: ISO8601
}