# TransferLane

object type

A transfer lane — ONE DIRECTED source→destination LF pair the operator has declared: never (a standing prohibition), always (the preferred donor class), or ranked (an explicit ordering). Group-scoped like a Brand (parent = the org group). THE MATRIX IS SPARSE + the geo seed is VIRTUAL: an ABSENT pair ranks by geodistance (LF→PF→PFL.geo) AT READ — no seeder materializes derivable rows; overriding the default = creating the specific lane. The PAIR is IMMUTABLE at birth (re-route = create + doom; src == dest refused) and UNIQUE per group (the ordered-pair marker — a LIVE duplicate is CONFLICT/IDENTITY_TAKEN naming the holder; a doomed holder is taken over). rank is REQUIRED iff mode is ranked and REFUSED otherwise (strict both ways; a mode moving OFF ranked DROPS the stored rank — the merged-record law). ⚠ INACTIVE = ABSENT, not never: deactivating returns the pair to the sparse geodistance default — a standing prohibition must stay ACTIVE never. A NON-doomed lane blocks BOTH its LFs dooms; deactivate stays FREE. Money reuses the MoneyEntry SDL (declared on the Product entry).

## Fields

| Field | Type | Notes |
| --- | --- | --- |
| `id` | [ID](/types/#scalars) `ID!` | The record’s id — a UUID the platform assigned when the record was created; every reference to this record uses it. |
| `sysId` | [String](/types/#scalars) `String!` | The group-scoped human-facing system id (TL-…). |
| `type` | [String](/types/#scalars) `String!` | The kind of record — always `TransferLane` here. |
| `caption` | [String](/types/#scalars) `String!` | The record’s display name — what people see it called. |
| `status` | [String](/types/#scalars) `String!` | The FSM state: active \| inactive \| doomed. |
| `parentId` | [ID](/types/#scalars) `ID!` | The parent org group; for a TransferLane parentId === rootId. |
| `rootId` | [ID](/types/#scalars) `ID!` | The org-group family root. |
| `createdAt` | [String](/types/#scalars) `String!` | When the record was created, as a UTC timestamp. |
| `updatedAt` | [String](/types/#scalars) `String!` | When the record last changed, as a UTC timestamp. |
| `revisionNum` | [Int](/types/#scalars) `Int!` | How many times this record has been edited; the first save is 0. |
| `revision` | [ID](/types/#scalars) `ID!` | The OCC revision token — supply it on every mutation of this record; rotates on every write. |
| `refCaptions` | [RefCaption](/types/RefCaption/) `[RefCaption!]!` | The server-composed captions of this record's declared references (the referenced-caption rule) — one row per referenced id; see RefCaption. |
| `sourceLfId` | [ID](/types/#scalars) `ID!` | The DONOR LF of this directed lane. IMMUTABLE at birth (the pair is the lane identity + its uniqueness marker). |
| `destinationLfId` | [ID](/types/#scalars) `ID!` | The RECEIVING LF of this directed lane. IMMUTABLE at birth. |
| `mode` | [TransferLaneMode](/types/TransferLaneMode/) `TransferLaneMode!` | The lane mode (never \| always \| ranked — the canned SPEC_REGISTRY set). Editable (the merged rank ⊕ mode law re-runs). |
| `rank` | [Int](/types/#scalars) | The explicit ordering (1..10000, lower first) — REQUIRED iff mode is ranked, REFUSED otherwise (strict both ways). |
| `typicalLeadTimeDays` | [Int](/types/#scalars) | Optional typical lane transit time in days (1..730; informational + engine provenance). Editable. |
| `weightClass` | [TransferLaneWeightClass](/types/TransferLaneWeightClass/) | Optional weight class — light out-ranks shipped at equal distance. Editable. |
| `costHint` | [MoneyEntry](/types/MoneyEntry/) | Optional per-transfer cost hint — house Money, NO currency gate (the.2 buy-vs-transfer compare consumes it ONLY currency-matched, -g). Editable. |

## Used by

- [createTransferLane](/reference/transfer-lane/createTransferLane/)
- [deactivateTransferLane](/reference/transfer-lane/deactivateTransferLane/)
- [doomTransferLane](/reference/transfer-lane/doomTransferLane/)
- [reactivateTransferLane](/reference/transfer-lane/reactivateTransferLane/)
- [transferLane](/reference/transfer-lane/transferLane/)
- [transferLanes](/reference/transfer-lane/transferLanes/)
- [updateTransferLane](/reference/transfer-lane/updateTransferLane/)