AlmondTill/G3N API

On this page

cancelTransferRequest

mutation · in the family Inventory operations

What it does

Cancel a stock-transfer request between your locations.

CANCEL a TransferRequest: draft / submitted cancel pure-FSM; open-cancel refuses CONFLICT/IN_PROGRESS when any line has shipped quantity OR any linked Transfer is live (the generalized has_shipments row; policy:reservations_released re-derives all-linked-terminal DEFENSIVELY). cancelled is the ONE doomed terminal (lists filter it; revival is a NEW TransferRequest). Requires the doc CURRENT revision (OCC) + the unrestricted capability.

Careful

Cancellation is usually permanent — check what the record has already caused (reservations, payments) before cancelling.

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

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 ExampleCancelTransferRequest($id: ID!, $revision: ID!, $reason: String) {
  cancelTransferRequest(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    requestingOrganizationId
    targetLogicalFacilityId
    neededBy
    priority
  }
}

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": {
    "cancelTransferRequest": {
      "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