AlmondTill/G3N API

On this page

createTransfer

mutation · in the family Inventory operations

What it does

Create a new stock transfer between locations at your organization.

CREATE a Transfer: lines FIXED at create (1..24 NAMED; distinct source IIs, each ACTIVE + STOCKED with its destination junction EXISTING at the destination LF — movements never auto-vivify, IV-b); both LFs ACTIVE; a same-LF pair refuses (relocateStock is the intra-LF sibling); the weight + org attribution derive from the live LF-PF-PFL spine and stamp IMMUTABLE.

Who may call it

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

Arguments

NameTypeRequiredNotes
inputCreateTransferInput CreateTransferInput!yesNo 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 ExampleCreateTransfer($input: CreateTransferInput!) {
  createTransfer(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    destinationLogicalFacilityId
    weight
    sourceOrganizationId
    destinationOrganizationId
    expectedArrivalAt
    carrierRefs
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "sourceLogicalFacilityId": "01900000-0000-7000-8000-4971feb30000",
    "destinationLogicalFacilityId": "01900000-0000-7000-8000-3885245e0000",
    "lines": [
      {
        "inventoryItemId": "01900000-0000-7000-8000-9307d9650000",
        "quantity": "2"
      }
    ]
  }
}

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

Example response

{
  "data": {
    "createTransfer": {
      "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