Required scopes: commerce_agent_knowledge_read
Arguments
Forward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.
Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with after; mutually exclusive with last/before.
Backward pagination: returns the last N items (max 100, default 25). Use with before; mutually exclusive with first/after.
Which key to sort by (defaults to createdAt, newest-first). Combine with reverse to flip direction.
Only include articles with this origin.
Case-insensitive substring match on title or content. For ranked search, use searchKnowledgeArticles.
Reverses the sort direction selected by orderBy (or its default).
Only include articles with this status.
Returns
A paginated list of KnowledgeArticle items.
The list of edges (each a node plus its pagination cursor).
Opaque cursor for this item; pass to after/before to page from here.
The item at this edge.
The article body as authored.
When the article was created.
When the article stops being retrievable. Null means no end.
When the article becomes retrievable, if status is ACTIVE. Null means immediately.
The id of this knowledge article.
How this article was created. Immutable after create.
Product families this article cites.Requires: products_read
ArgumentsForward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.
Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with after; mutually exclusive with last/before.
Backward pagination: returns the last N items (max 100, default 25). Use with before; mutually exclusive with first/after.
Other knowledge articles this article cites.Requires: commerce_agent_knowledge_read
ArgumentsForward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.
Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with after; mutually exclusive with last/before.
Backward pagination: returns the last N items (max 100, default 25). Use with before; mutually exclusive with first/after.
Whether Commerce Agent may retrieve this article. Combine with the effective window.
The merchant-facing title of the article.
When the article body was last edited.
The nodes in this page, without the edge/cursor wrapper — a convenience over edges.
The article body as authored.
When the article was created.
When the article stops being retrievable. Null means no end.
When the article becomes retrievable, if status is ACTIVE. Null means immediately.
The id of this knowledge article.
How this article was created. Immutable after create.
Product families this article cites.Requires: products_read
ArgumentsForward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.
Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with after; mutually exclusive with last/before.
Backward pagination: returns the last N items (max 100, default 25). Use with before; mutually exclusive with first/after.
The list of edges (each a node plus its pagination cursor).
The nodes in this page, without the edge/cursor wrapper — a convenience over edges.
Pagination metadata for the current page.
Other knowledge articles this article cites.Requires: commerce_agent_knowledge_read
ArgumentsForward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.
Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with after; mutually exclusive with last/before.
Backward pagination: returns the last N items (max 100, default 25). Use with before; mutually exclusive with first/after.
Whether Commerce Agent may retrieve this article. Combine with the effective window.
The merchant-facing title of the article.
When the article body was last edited.
Pagination metadata for the current page.
Cursor of the last edge in this page; pass to after to page forward.
Whether more items exist after this page (drives forward pagination with first/after).
Whether more items exist before this page (drives backward pagination with last/before).
Cursor of the first edge in this page; pass to before to page backward.
Example
