Querying Composite Products

This guide covers all composite product query capabilities provided by WooGraphQL Pro.

query GetCompositeProduct($id: ID!) {
  product(id: $id, idType: DATABASE_ID) {
    ... on CompositeProduct {
      id
      databaseId
      name
      slug
      description
      shortDescription
      image {
        sourceUrl
      }
    }
  }
}

query GetCompositeConfig($id: ID!) {
  product(id: $id, idType: DATABASE_ID) {
    ... on CompositeProduct {
      # Layout and display
      layout
      addToCartFormLocation
      shopPriceCalculation

      # Behavior
      editableInCart
      virtualComposite
      soldIndividuallyContext
    }
  }
}

Components are the building blocks of composite products:

query GetCompositeComponents($id: ID!) {
  product(id: $id, idType: DATABASE_ID) {
    ... on CompositeProduct {
      components {
        # Identity
        id
        componentId
        title
        slug
        description
        thumbnail {
          sourceUrl
        }

        # Options configuration
        queryType
        optional

        # Display settings
        optionsStyle
        paginationStyle
        showSortingOptions
        showFilteringOptions

        # Quantity constraints
        minQuantity
        maxQuantity
        defaultQuantity

        # Pricing
        pricedIndividually
        discount
        shippedIndividually

        # Behavior
        optionsSelectAction
      }
    }
  }
}

Get available products for a component:

query GetComponentOptions($id: ID!) {
  product(id: $id, idType: DATABASE_ID) {
    ... on CompositeProduct {
      components {
        componentId
        title

        # Available options
        queryOptions {
          nodes {
            id
            databaseId
            name
            slug
            price
            stockStatus
            image {
              sourceUrl
            }

            # Handle variable products
            ... on VariableProduct {
              variations {
                nodes {
                  id
                  databaseId
                  name
                  price
                  stockStatus
                  attributes {
                    nodes {
                      name
                      value
                    }
                  }
                }
              }
            }
          }
        }

        # Default selection
        defaultOption {
          id
          name
          price
        }
      }
    }
  }
}

Scenarios enable conditional logic for components and options:

query GetCompositeScenarios($id: ID!) {
  product(id: $id, idType: DATABASE_ID) {
    ... on CompositeProduct {
      scenarios {
        id
        scenarioId
        name
        description
        enabled

        # Conditions
        configuration {
          component {
            componentId
            title
          }
          componentOptions {
            nodes {
              id
              name
            }
          }
          optionsModifier
        }

        # Actions
        actions {
          actionId
          isActive
          hiddenComponents {
            componentId
            title
          }
          hiddenOptions {
            component {
              componentId
            }
            componentOptions {
              nodes {
                id
                name
              }
            }
          }
        }
      }
    }
  }
}

query GetCompositeProducts($first: Int = 12) {
  products(first: $first, where: { type: COMPOSITE }) {
    nodes {
      ... on CompositeProduct {
        id
        name
        price
        image {
          sourceUrl
        }
        layout
        components {
          title
          optional
        }
      }
    }
  }
}

query GetCompositeProductsPaginated($first: Int, $after: String) {
  products(first: $first, after: $after, where: { type: COMPOSITE }) {
    pageInfo {
      hasNextPage
      endCursor
    }
    nodes {
      ... on CompositeProduct {
        id
        name
        price
      }
    }
  }
}

A comprehensive query for a composite product page:

query GetFullCompositeProduct($id: ID!) {
  product(id: $id, idType: DATABASE_ID) {
    ... on CompositeProduct {
      # Identity
      id
      databaseId
      name
      slug
      description
      shortDescription

      # Media
      image {
        sourceUrl
        altText
      }
      galleryImages {
        nodes {
          sourceUrl
        }
      }

      # Pricing
      price
      regularPrice
      salePrice

      # Configuration
      layout
      addToCartFormLocation
      editableInCart
      shopPriceCalculation

      # Stock
      stockStatus
      stockQuantity

      # Components with full details
      components {
        id
        componentId
        title
        description
        thumbnail {
          sourceUrl
        }

        # Options
        queryType
        optional
        optionsStyle
        paginationStyle

        # Quantities
        minQuantity
        maxQuantity
        defaultQuantity

        # Pricing
        pricedIndividually
        discount

        # Default and available options
        defaultOption {
          id
          databaseId
          name
          price
        }

        queryOptions {
          nodes {
            id
            databaseId
            name
            slug
            price
            stockStatus
            image {
              sourceUrl
            }

            ... on VariableProduct {
              variations {
                nodes {
                  id
                  databaseId
                  name
                  price
                  stockStatus
                  attributes {
                    nodes {
                      name
                      value
                    }
                  }
                }
              }
              attributes {
                nodes {
                  name
                  options
                  variation
                }
              }
            }
          }
        }
      }

      # Scenarios for conditional logic
      scenarios {
        scenarioId
        name
        enabled
        configuration {
          component {
            componentId
          }
          componentOptions {
            nodes {
              id
            }
          }
          optionsModifier
        }
        actions {
          actionId
          isActive
          hiddenComponents {
            componentId
          }
        }
      }

      # Related products
      related {
        nodes {
          id
          name
        }
      }
    }
  }
}

Components have detailed visibility settings:

query GetComponentVisibility($id: ID!) {
  product(id: $id, idType: DATABASE_ID) {
    ... on CompositeProduct {
      components {
        componentId
        title

        # What to show for selected products
        selectionDetailVisibility

        # Where to show subtotals
        subtotalVisibility
      }
    }
  }
}

• Adding Composites to Cart - The addCompositeToCart mutation
• API Types Reference - Type definitions