AlmondTill/G3N API

On this page

purchaseOrderLines

query · in the family Reading your records

What it does

The lines on one purchase order — what you ordered, where each lot is going, and how much of it has landed.

ONE PurchaseOrder's own lines, lineNo-ORDERED + born-paginated. purchaseOrderId is the REQUIRED anchor (tenant-scoped — a cross-tenant/missing order refuses NOT_FOUND, never an empty page). 'nextToken' = the prior page's cursor, verbatim (opaque; malformed/foreign → VALIDATION/INVALID). Requires authentication.

What happens

Reads only — changes nothing. Comes a page at a time, in line order, and can be narrowed to one product, one receiving location, or an arrival window.

Who may call it

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

Arguments

NameTypeRequiredNotes
purchaseOrderIdID ID!yesNo further notes.
filterFilterInputnoWhich records to answer — clauses over the family’s filterable fields (the FilterInput type and the paging guide carry the grammar).
sortSortInputnoThe order to answer in — one declared field and a direction (the SortInput type carries the grammar).
limitIntnoHow many records to answer at most; a page may hold fewer.
nextTokenStringnoThe cursor from the previous page, passed back exactly as received.

Returns

PurchaseOrderLinePage PurchaseOrderLinePage! — One page of a PurchaseOrder's own line collection.

This is a page: items holds the records and nextToken the cursor for the next page — pass it back verbatim until it is null. See paging.

Example request

query ExamplePurchaseOrderLines($purchaseOrderId: ID!, $limit: Int) {
  purchaseOrderLines(purchaseOrderId: $purchaseOrderId, limit: $limit) {
    items {
      lineNo
      variantId
      logicalFacilityId
      quantity
      manufacturerId
      expectedArrivalAt
      receivedQty
      outstandingQty
      purchasePackId
      packQuantity
    }
    nextToken
    matchCount
  }
}

Variables:

{
  "purchaseOrderId": "01900000-0000-7000-8000-54a5b8570000",
  "limit": 1
}

Example response

{
  "data": {
    "purchaseOrderLines": {
      "items": [
        {
          "lineNo": 1,
          "variantId": "01900000-0000-7000-8000-8415e73b0000",
          "logicalFacilityId": "01900000-0000-7000-8000-8026f71c0000",
          "quantity": "2",
          "manufacturerId": "01900000-0000-7000-8000-7cefed4d0000",
          "expectedArrivalAt": "2027-01-31T00:00:00.000Z",
          "receivedQty": "<received qty>",
          "outstandingQty": "<outstanding qty>",
          "purchasePackId": "01900000-0000-7000-8000-031157c60000",
          "packQuantity": 1
        }
      ],
      "nextToken": "<the cursor from the previous page>",
      "matchCount": 1
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer