Commerce Agent

​

Queries

• knowledgeArticle — Fetch a single Commerce Agent knowledge article by its id.
• knowledgeArticles — List Commerce Agent knowledge articles, optionally filtered by title/body substring, status, or origin.
• searchKnowledgeArticles — Ranked text search over Commerce Agent knowledge articles, including drafts and disabled articles. Ranking is not keyset-paginated; cap results with first.

​

Mutations

• createKnowledgeArticle — Create a Commerce Agent knowledge article. Defaults to DRAFT so it is not retrievable until you set status to ACTIVE.
• deleteKnowledgeArticle — Delete a Commerce Agent knowledge article. Returns true if an owned article was deleted, false if none matched.
• updateKnowledgeArticle — Update a Commerce Agent knowledge article. Returns null if no owned article matches the id.

​

Objects

• KnowledgeArticle — A Commerce Agent knowledge article the merchant authored or imported. Retrieval eligibility lives on status and the effective window, not on the body.

​

Input objects

• CreateKnowledgeArticleInput — Fields for a new Commerce Agent knowledge article. Defaults to DRAFT so nothing is retrievable until you set status to ACTIVE.
• UpdateKnowledgeArticleInput — Fields to change. Omit a field to leave it unchanged. Sending referencedProductFamilyIds or referencedArticleIds replaces that set.

​

Enums

• KnowledgeArticleOrigin — How this article was created. Immutable after create.
• KnowledgeArticleSortKey — A field this list can be ordered by; pass to the list’s orderBy argument and pair with reverse to flip direction.
• KnowledgeArticleStatus — Whether Commerce Agent may retrieve this article, independent of its schedule.