Skip to content

list_product_group_relationships

List a product group’s parent-child relationships. Returns parentRelationship (the kept relationship to its parent group, or null when the group is standalone) and childRelationships (a cursor-paginated list of kept relationships to its child groups). Each relationship exposes its currently kept field links under fields — a list of link nodes, each with id, the related field (e.g. STATE, MIN_NIGHTS, CONTRACT_DATES) and its type (SYNC or UPPER_BOUND). Reads require the catalog:product_groups:read_parent_child_relationship scope.

Parameter Type Required Description
productGroupId string Yes The ID of the product group whose relationships to retrieve
first number No Number of child relationships to return (forward pagination). Maximum 25. Defaults to 25 if neither first nor last is provided.
after string No Cursor for forward pagination of child relationships. Pass the endCursor from the previous page.
last number No Number of child relationships to return (backward pagination). Maximum 25. Use with before for reverse paging.
before string No Cursor for backward pagination of child relationships. Pass the startCursor from the previous page.
Field Type Description
content ContentItem[] Array of content items returned by the tool - ContentItem
isError boolean Whether the tool execution resulted in an error
Field Type Description
type 'text' Content type (currently only ‘text’ is supported)
text string The text content to display