AlmondTill/G3N API

On this page

agentChannelCatalogLookup

query · in the family Reading your records

What it does

Resolve product, variant, SKU or barcode identifiers to the listed products an agent would see.

THE AGENT CATALOG — lookup: resolve up to 50 identifiers (a listed Product id → its featured first variant · a listed Variant id · a listed variant's SKU or barcode → that variant exactly) to listed products whose variants carry inputs; identifiers reaching nothing listed are named in notFound (never an error — the spec's partial-success shape). The same principal law as the search.

What happens

Reads only. Identifiers that are not listed are named, never an error.

Who may call it

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

Arguments

NameTypeRequiredNotes
agentChannelIdID ID!yesNo further notes.
idsString [String!]!yesNo further notes.

Returns

AgentChannelCatalogLookup AgentChannelCatalogLookup! — The agentChannelCatalogLookup answer — every returned variant carries inputs (which identifiers reached it); notFound names the identifiers that resolved to nothing listed (request order).

Example request

query ExampleAgentChannelCatalogLookup($agentChannelId: ID!, $ids: [String!]!) {
  agentChannelCatalogLookup(agentChannelId: $agentChannelId, ids: $ids) {
    notFound
    truncated
  }
}

Variables:

{
  "agentChannelId": "01900000-0000-7000-8000-d23fae740000",
  "ids": [
    "<ids>"
  ]
}

Example response

{
  "data": {
    "agentChannelCatalogLookup": {
      "notFound": [
        "<not found>"
      ],
      "truncated": true
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer