AlmondTill/G3N API

On this page

binStock

query · in the family Reading your records

What it does

What is sitting in one bin.

One Bin StockRecord rows across items. Requires authentication; a cross-tenant/missing id reads as an empty list.

What happens

Reads only.

Who may call it

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

Arguments

NameTypeRequiredNotes
binIdID ID!yesNo further notes.

Returns

StockRecord [StockRecord!]! — One StockRecord bin/lot SHARD of an InventoryItem: NOT a construct — sysId-less and FSM-less, existing only where stock has landed in a bin (zero records = everything un-binned, the small-merchant case). Carries ONLY the three LOCATABLE buckets (reserved is a claim overlay, in_transit is not physically here — both stay on the item caches); quantities are NON-NEGATIVE (a relocate refuses driving a record negative — CONFLICT/INSUFFICIENT_STOCK). The DERIVED un-binned pool = item caches minus the record sums (see verifyInventoryItem). Records persist at zero; a zeroed record does NOT block its bin (the moved-or-zeroed rule).

Example request

query ExampleBinStock($binId: ID!) {
  binStock(binId: $binId) {
    inventoryItemId
    binId
    lotCode
    lotExpiresAt
    onHandQty
    damagedQty
    heldQty
    createdAt
    updatedAt
    revisionNum
  }
}

Variables:

{
  "binId": "01900000-0000-7000-8000-20867aa30000"
}

Example response

{
  "data": {
    "binStock": [
      {
        "inventoryItemId": "01900000-0000-7000-8000-9307d9650000",
        "binId": "01900000-0000-7000-8000-20867aa30000",
        "lotCode": "BJ-001",
        "lotExpiresAt": "2027-01-31T00:00:00.000Z",
        "onHandQty": "<on hand qty>",
        "damagedQty": "<damaged qty>",
        "heldQty": "<held qty>",
        "createdAt": "2027-01-31T00:00:00.000Z",
        "updatedAt": "2027-01-31T00:00:00.000Z",
        "revisionNum": 1
      }
    ]
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer