On this page

agentChannelCatalogSearch

query · in the family Reading your records

What it does

What AI shopping agents can see and buy from this channel right now — the listed products searched by words and filters, priced at the selling location, with in-stock words.

THE AGENT CATALOG — search: what the AgentChannel LISTS (the listing rule — the ACTIVE listed Collections' active products, active variants minus the veto list, ranged + priced at the selling location NOW, the PriceList plane when set), matched by query words (title · description · code · variant titles · codes · SKUs; all words, case/diacritic-folded) and/or filters (category captions OR-matched; price bounds in the listing currency's minor units), paged (limit default 10, max 50; an opaque cursor bound to the criteria). At least one of query/categories/price is required. The agent_platform principal reads ONLY its own channel (any other id → AUTHZ/FORBIDDEN); staff planes read any channel of the group (a missing/foreign channel → NOT_FOUND). This is EXACTLY what an agent platform sees on the shop's host — the merchant's preview.

What happens

Reads only. Exactly what a trusted platform gets on the shop’s own host — the merchant’s preview.

Who may call it

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

Owner
System Administrator
Manager
Associate Manager
Warehouse Associate
Sales Associate
An API key whose scope allows api:agentChannelCatalogSearch

Arguments

Name	Type	Required	Notes
`agentChannelId`	ID `ID!`	yes	No further notes.
`query`	String	no	No further notes.
`categories`	String `[String!]`	no	No further notes.
`priceMinMinor`	Int	no	No further notes.
`priceMaxMinor`	Int	no	No further notes.
`limit`	Int	no	How many records to answer at most; a page may hold fewer.
`cursor`	String	no	No further notes.

Returns

AgentChannelCatalogPage AgentChannelCatalogPage! — One page of agentChannelCatalogSearch — the listing order (collection order · the evaluator's order within a collection); nextCursor present iff a page follows; truncated when the listing was cut at its ceiling.

Example request

query ExampleAgentChannelCatalogSearch($agentChannelId: ID!, $query: String) {
  agentChannelCatalogSearch(agentChannelId: $agentChannelId, query: $query) {
    nextCursor
    totalCount
    truncated
  }
}

Variables:

{
  "agentChannelId": "01900000-0000-7000-8000-d23fae740000",
  "query": "<query>"
}

Example response

{
  "data": {
    "agentChannelCatalogSearch": {
      "nextCursor": "<next cursor>",
      "totalCount": 1,
      "truncated": true
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

VALIDATION/INVALID — Something in the request is not valid. (VALIDATION)
AUTHN/REQUIRED — Sign in to do this. (AUTHN)
AUTHZ/FORBIDDEN — Your role does not allow this action. (AUTHZ)
RATE_LIMIT/THROTTLED — Too many requests in a short time. (RATE_LIMIT)
NOT_FOUND/* — That record could not be found. (NOT_FOUND)