AlmondTill/G3N API

On this page

inventoryItems

query · in the family Inventory item

What it does

The inventory item list — each entry is an inventory item — one variant’s stock identity.

The caller's org-group family's ACTIVE LISTING of InventoryItems — doomed records DROP from listings.

What happens

Reads only — changes nothing.

Who may call it

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

Returns

InventoryItem [InventoryItem!]! — An inventory item: ONE per (Variant x LogicalFacility), carrying the CACHED bucket balances + the weighted-moving-average cost. Parent = the Variant; the other junction leg is the IMMUTABLE logicalFacilityId. The junction (variant x LF) is unique (a live duplicate is CONFLICT/IDENTITY_TAKEN naming the holder). styleType is BIRTH-STAMPED from the spine (immutable upstream): simple/kit IIs are STOCKED; service/bundle IIs are STOCKLESS price-carriers refusing quantity movements. Buckets are SIGNED decimal strings moved ONLY by the movement ops (receiveStock/adjustStock/reclassStock: one movement = ONE transaction; overcommit is allowed + ALWAYS evented, IV-i); available = on_hand − reserved, ALWAYS derived, never stored. Doom requires EVERY bucket exactly zero (CONFLICT/REFERENCED naming the non-zero buckets); deactivate is FREE and reversible. onOrderQty is a SIXTH field, NOT a bucket: the open quantity of the issued purchase orders for this junction, maintained by the purchase-order walks + the receipt post — never by movements, never inside available; a pre-walk row reads 0; the audit/repair pair (inventoryOnOrderAudit / repairInventoryOnOrder) stamps the derived truth over drift.

Example request

query ExampleInventoryItems {
  inventoryItems {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    logicalFacilityId
    styleType
    controlClass
    onHandQty
    reservedQty
    inTransitQty
    damagedQty
    heldQty
    onOrderQty
    availableQty
  }
}

Example response

{
  "data": {
    "inventoryItems": [
      {
        "id": "01900000-0000-7000-8000-37386ae00000",
        "sysId": "IV-EXMP-0000-000F",
        "type": "InventoryItem",
        "caption": "Blue jeans",
        "status": "active",
        "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",
        "logicalFacilityId": "01900000-0000-7000-8000-8026f71c0000",
        "styleType": "<style type>",
        "controlClass": "<control class>",
        "onHandQty": "<on hand qty>",
        "reservedQty": "<reserved qty>",
        "inTransitQty": "<in transit qty>",
        "damagedQty": "<damaged qty>",
        "heldQty": "<held qty>",
        "onOrderQty": "<on order qty>",
        "availableQty": "<available qty>"
      }
    ]
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer