AlmondTill/G3N API

On this page

purchasePack

query · in the family Purchase pack

What it does

Look up one record — a purchase pack — the case/pack size a vendor sells in.

A PurchasePack by id, within the caller's OWN org-group family; requires authentication. A cross-tenant id reads as null (not-found) AND trips the rootId tripwire server-side.

What happens

Reads only — changes nothing.

Who may call it

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

Arguments

NameTypeRequiredNotes
idID ID!yesThe id of the record.

Returns

PurchasePack — A purchase pack — a purchasing/handling packaging definition ON a variant (case of 24, pallet of 480): NOT a UoM conversion (the inventory ledger is ALWAYS in the variant stock UoM — reaffirmed); a pack is packaging metadata + a line-ENTRY breakdown step (PO/Receipt lines entered in packs resolve to stock units at entry: packQuantity x unitsPerPack). Parent = the VARIANT (0..N packs per variant). unitsPerPack is IMMUTABLE at birth, which keeps every stored document line reconstructible forever. The code is a dup-gated LABEL (trim+case-fold vs LIVE siblings on the same variant, naming the holder — lean 1: no UNIQ marker). Live packs block the parent Variant doom (the children law); live OrgVendorItems naming a pack block ITS doom; deactivate stays FREE everywhere (an inactive pack refuses NEW line entry while its unitsPerPack keeps denominating stored terms).

Example request

query ExamplePurchasePack($id: ID!) {
  purchasePack(id: $id) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    code
    unitsPerPack
    packGtin
    nominalWeightKg
    lengthCm
    widthCm
    heightCm
  }
}

Variables:

{
  "id": "01900000-0000-7000-8000-37386ae00000"
}

Example response

{
  "data": {
    "purchasePack": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "PK-EXMP-0000-000F",
      "type": "PurchasePack",
      "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",
      "code": "BJ-001",
      "unitsPerPack": "<units per pack>",
      "packGtin": "<pack gtin>",
      "nominalWeightKg": "<nominal weight kg>",
      "lengthCm": "<length cm>",
      "widthCm": "<width cm>",
      "heightCm": "<height cm>"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer