AlmondTill/G3N API

On this page

stockCard

query · in the family Reading your records

What it does

One item’s full stock story at a location — every movement, in order.

The Stock Card: one InventoryItem's posted movement entries, NEWEST-FIRST + bounded (limit defaults 50, clamps 1..200; before = an EXCLUSIVE upper entry-id bound — v7 ids are time-ordered, the older-page cursor). Voided entries excluded. Requires authentication; the II is tenant-scoped server-side.

What happens

Reads only — the audit view of how the on-hand got here.

Who may call it

Capability area: Reading your records — Looking up and listing the records of your organization.

Arguments

NameTypeRequiredNotes
inventoryItemIdID ID!yesNo further notes.
limitIntnoHow many records to answer at most; a page may hold fewer.
beforeIDnoNo further notes.

Returns

InventoryEntry [InventoryEntry!]! — ONE posted Stock-Card movement fact: the magnitude rides quantity (POSITIVE), the direction rides fromBucket/toBucket (the classic in/out card form; a bucket balance = sum of to minus sum of from). sysId-LESS (the class); IMMUTABLE — NO update or doom op exists; posted ONLY by the movement mutations in ONE transaction with the II cache stamp.

Example request

query ExampleStockCard($inventoryItemId: ID!, $limit: Int) {
  stockCard(inventoryItemId: $inventoryItemId, limit: $limit) {
    id
    type
    caption
    status
    parentId
    rootId
    movement
    quantity
    fromBucket
    toBucket
    reason
    refs
    overcommitted
    fromBinId
    toBinId
    lotCode
    createdAt
    updatedAt
    revision
    revisionNum
  }
}

Variables:

{
  "inventoryItemId": "01900000-0000-7000-8000-9307d9650000",
  "limit": 1
}

Example response

{
  "data": {
    "stockCard": [
      {
        "id": "01900000-0000-7000-8000-37386ae00000",
        "type": "<type>",
        "caption": "Blue jeans",
        "status": "<status>",
        "parentId": "01900000-0000-7000-8000-065235280000",
        "rootId": "01900000-0000-7000-8000-a093dd800000",
        "movement": "receive",
        "quantity": "2",
        "fromBucket": "on_hand",
        "toBucket": "on_hand",
        "reason": "Correcting a miscount.",
        "refs": [
          "<refs>"
        ],
        "overcommitted": true,
        "fromBinId": "01900000-0000-7000-8000-f29255530000",
        "toBinId": "01900000-0000-7000-8000-c548ffc80000",
        "lotCode": "BJ-001",
        "createdAt": "2027-01-31T00:00:00.000Z",
        "updatedAt": "2027-01-31T00:00:00.000Z",
        "revision": "01900000-0000-7000-8000-b7960e180000",
        "revisionNum": 1
      }
    ]
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

Used in