AlmondTill/G3N API

On this page

createTransferRequest

mutation · in the family Inventory operations

What it does

Create a new stock-transfer request between your locations at your organization.

CREATE a TransferRequest: lines FIXED at create (1..24 NAMED — TR-o; distinct variants, each resolving an EXISTING requesting-LF InventoryItem junction — IV-b demand-side, refusal NAMED {lineNo, variantId, logicalFacilityId}); the requesting LF ACTIVE (+ the target LF resolvable when named; target == requesting refuses); the org attribution derives from the live spine and stamps IMMUTABLE.

Who may call it

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

Arguments

NameTypeRequiredNotes
inputCreateTransferRequestInput CreateTransferRequestInput!yesNo further notes.

Returns

TransferRequest TransferRequest! — A stock transfer request: a requesting LF asks variants x quantities of the group (open sourcing) or of ONE targeted source LF. Lines are EMBEDDED, VARIANT-keyed + birth-fixed (max 24 — TR-o); cancelled is the ONE doomed terminal (lists filter it); fulfilled/closed_short are IMMUTABLE non-doomed history — a write there refuses CONFLICT/IMMUTABLE.

Example request

mutation ExampleCreateTransferRequest($input: CreateTransferRequestInput!) {
  createTransferRequest(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    requestingOrganizationId
    targetLogicalFacilityId
    neededBy
    priority
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "requestingLogicalFacilityId": "01900000-0000-7000-8000-9b4a35b10000",
    "lines": [
      {
        "variantId": "01900000-0000-7000-8000-8415e73b0000",
        "quantity": "2",
        "orderLineRef": {
          "orderId": "01900000-0000-7000-8000-f6d8263a0000",
          "orderLineNo": 1
        }
      }
    ]
  }
}

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

Example response

{
  "data": {
    "createTransferRequest": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "TR-EXMP-0000-000F",
      "type": "TransferRequest",
      "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",
      "requestingOrganizationId": "01900000-0000-7000-8000-93bd40d40000",
      "targetLogicalFacilityId": "01900000-0000-7000-8000-2938ce830000",
      "neededBy": "<needed by>",
      "priority": "low"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

Used in