AlmondTill/G3N API

On this page

shipTransfer

mutation · in the family Inventory operations

What it does

Ship a transfer — the stock physically leaves the sender.

SHIP a ready Transfer (ready -> in_transit): per line ONE transfer_out entry @src (on_hand-, relief at the source CURRENT WMA — its book unchanged) + ONE transfer_in entry @dest (in_transit+ at VALUE-AT-SHIP q x srcWMA; the dest WMA re-weights; the currency birth law applies NAMED) + the reserved claim release, ALL in ONE transaction with the doc rollups + the optional ship metadata. Re-verifies PRESENT stock (reserved >= q AND on_hand >= q — CONFLICT/INSUFFICIENT_STOCK at location facility). Both LFs ACTIVE; requires the doc CURRENT revision (OCC) + the unrestricted capability.

What happens

The sender’s books drop; the goods are in transit.

Who may call it

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

Arguments

NameTypeRequiredNotes
inputShipTransferInput ShipTransferInput!yesNo further notes.
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

Transfer Transfer! — A stock transfer: ONE shipment event moving stock between two LogicalFacilities of the SAME org group (the never-cross-group law IS the tenancy boundary; the source and destination ORGS may differ = intercompany, attribution stamped at birth). LIGHT weight (same physical location — birth-derived from the LF-PF-PFL spine) completes in the ONE submit step (no reserve, no in_transit). Cancel is pre-ship ONLY; cancelled is the ONE doomed terminal (lists filter it); completed/closed are IMMUTABLE non-doomed history — a write there refuses CONFLICT/IMMUTABLE.

Example request

mutation ExampleShipTransfer($input: ShipTransferInput!, $revision: ID!, $reason: String) {
  shipTransfer(input: $input, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    destinationLogicalFacilityId
    weight
    sourceOrganizationId
    destinationOrganizationId
    expectedArrivalAt
    carrierRefs
  }
}

Variables:

{
  "input": {
    "transferId": "01900000-0000-7000-8000-1d47d93b0000",
    "expectedArrivalAt": "2027-01-31T00:00:00.000Z"
  },
  "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": {
    "shipTransfer": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "TF-EXMP-0000-000F",
      "type": "Transfer",
      "caption": "Blue jeans",
      "status": "draft",
      "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",
      "destinationLogicalFacilityId": "01900000-0000-7000-8000-3885245e0000",
      "weight": "<weight>",
      "sourceOrganizationId": "01900000-0000-7000-8000-b627156a0000",
      "destinationOrganizationId": "01900000-0000-7000-8000-fcbbe67d0000",
      "expectedArrivalAt": "2027-01-31T00:00:00.000Z",
      "carrierRefs": [
        "<carrier refs>"
      ]
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

Used in