AlmondTill/G3N API

On this page

doomTransferLane

mutation · in the family Transfer lane

What it does

Permanently retire a transfer lane — a named sender→receiver route stock moves along.

Doom (terminal) a TransferLane by id; requires the unrestricted capability + the record's CURRENT revision. Deny-by-default + the referential_integrity / authority / occ guards; a doomed TransferLane is immutable + never deleted. The optional reason rides the transition events.

Careful

Doom is forever — a doomed record never comes back into use (its history remains readable). Anything still referencing it live will block the doom.

Who may call it

Capability area: Inventory operations — Receiving, counting, transferring and moving stock.

Arguments

NameTypeRequiredNotes
idID ID!yesThe id of the record.
revisionID ID!yesThe revision id you read on the record; the change is refused if an edit landed in the meantime.
reasonStringnoNo further notes.

Returns

TransferLane TransferLane! — 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).

Example request

mutation ExampleDoomTransferLane($id: ID!, $revision: ID!, $reason: String) {
  doomTransferLane(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    sourceLfId
    destinationLfId
    mode
    rank
    typicalLeadTimeDays
    weightClass
  }
}

Variables:

{
  "id": "01900000-0000-7000-8000-37386ae00000",
  "revision": "01900000-0000-7000-8000-b7960e180000",
  "reason": "Correcting a miscount."
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "doomTransferLane": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "TL-EXMP-0000-000F",
      "type": "TransferLane",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "sourceLfId": "01900000-0000-7000-8000-366bfb930000",
      "destinationLfId": "01900000-0000-7000-8000-7bd4ce680000",
      "mode": "never",
      "rank": 1,
      "typicalLeadTimeDays": 1,
      "weightClass": "light"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer