AlmondTill/G3N API

On this page

agentChannel

query · in the family Agent channel

What it does

Look up one agent channel — its controls, lifecycle state and public signing keys.

A AgentChannel 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.

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

AgentChannel — An AgentChannel — the merchant’s CONTROLS over the agentic-commerce channel: exactly ONE record per Organization that says WHAT an AI shopping agent may sell over the open Universal Commerce Protocol and HOW — the selling location (prices · stock · tax origin), the listed Collections (EMPTY = nothing listed), an optional agent price plane (a PriceList), discount codes on/off, a checkout cap, the fulfillment methods + flat-rate shipping cards + ship-to countries + pickup locations, the buyer facts required, the pre-approved agent platforms (EMPTY = every platform refused), the buyer-consent defaults, the return/warranty policy texts, the checkout session TTL, and the engine-minted ES256 signing keys (the PUBLIC halves — the private halves live in the credential store, never on the wire). Lifecycle draft → live → paused → live | doomed: publish and resume run the completeness rule record-aware (the channel must be able to sell); pause withholds the channel (agents read unavailable + Retry-After); a LIVE channel never dooms in one step (pause first); doom releases the one-per-org marker so the organization may start over. The protocol doors (the profile, the catalog, the checkout — onward) READ this record; the adapter adds no business rule of its own. Payment handlers are NEVER typed here — the profile derives them from the organization’s connected-account facts.

Example request

query ExampleAgentChannel($id: ID!) {
  agentChannel(id: $id) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    logicalFacilityId
    pickupLogicalFacilityIds
    shipToCountries
    collectionIds
    divisionId
    showStockLevels
    excludedVariantIds
    priceListId
    allowDiscountCodes
    maxCheckoutTotalMinor
    fulfillmentMethods
    handlingDays
    requireBuyerEmail
    requireBuyerPhone
    rateClass
    returnPolicy
    warrantyPolicy
    checkoutTtlMinutes
    identityLinking
    requireLinkedBuyer
  }
}

Variables:

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

Example response

{
  "data": {
    "agentChannel": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "AG-EXMP-0000-000F",
      "type": "AgentChannel",
      "caption": "Blue jeans",
      "status": "draft",
      "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",
      "pickupLogicalFacilityIds": [
        "01900000-0000-7000-8000-095d4a1d0000"
      ],
      "shipToCountries": [
        "<ship to countries>"
      ],
      "collectionIds": [
        "01900000-0000-7000-8000-b1c179550000"
      ],
      "divisionId": "01900000-0000-7000-8000-25bd925b0000",
      "showStockLevels": true,
      "excludedVariantIds": [
        "01900000-0000-7000-8000-6ad77b420000"
      ],
      "priceListId": "01900000-0000-7000-8000-7844e9fb0000",
      "allowDiscountCodes": true,
      "maxCheckoutTotalMinor": 1,
      "fulfillmentMethods": [
        "ship"
      ],
      "handlingDays": 1,
      "requireBuyerEmail": true,
      "requireBuyerPhone": true,
      "rateClass": "low",
      "returnPolicy": "<return policy>",
      "warrantyPolicy": "<warranty policy>",
      "checkoutTtlMinutes": 1,
      "identityLinking": true,
      "requireLinkedBuyer": true
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer