AlmondTill/G3N API

On this page

resolveIdentifier

query · in the family Reading your records

What it does

Scan lookup — which variant does this barcode belong to?

The locked resolution: current + ledgered values as ONE namespace per kind — a historical match still resolves to its variant (outdated-flagged); ALL matches, most-recent-first. organizationId REQUIRED for plu/gtin, REFUSED for sku. ZERO matches → NOT_FOUND/IDENTIFIER. Requires authentication.

What happens

Reads only — the till’s scan path.

Who may call it

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

Arguments

NameTypeRequiredNotes
kindString String!yesNo further notes.
valueString String!yesNo further notes.
organizationIdIDnoNo further notes.

Returns

IdentifierResolutionMatch [IdentifierResolutionMatch!]! — One resolution hit (the locked -trail rule): the ledgered entry + its hydrated bearer Variant + the current/outdated flag.

Example request

query ExampleResolveIdentifier($kind: String!, $value: String!, $organizationId: ID) {
  resolveIdentifier(kind: $kind, value: $value, organizationId: $organizationId) {
    current
  }
}

Variables:

{
  "kind": "<kind>",
  "value": "<value>",
  "organizationId": "01900000-0000-7000-8000-44b781470000"
}

Example response

{
  "data": {
    "resolveIdentifier": [
      {
        "current": true
      }
    ]
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer