Required scopes: commerce_agent_knowledge_read, commerce_agent_knowledge_write
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).
Opaque cursor for this item; pass to after/before to page from here.
The nodes in this page, without the edge/cursor wrapper — a convenience over edges.
Look up a single attribute on this family by its name, if set.Requires: products_read
ArgumentsThe machine name of the attribute to look up.
The merchant-defined attributes set on this family.
When the record was created.
The product family’s long-form description.
The id of this product family.
The first (default) image for this family, if any.Requires: products_read A paginated list of the family’s images.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 variant options (e.g. Size, Color) for this family.
A paginated list of the products (variants) in this family.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.
Free-form tags applied to the product family.
The product family’s title.
When the record was last updated.
The vendor or manufacturer of the product family.
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.
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.
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 nodes in this page, without the edge/cursor wrapper — a convenience over edges.
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.
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.
