Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.heychocolate.com/llms.txt

Use this file to discover all available pages before exploring further.

​
simulateScenario

Run a single scenario simulation against a product baseline. 
mutation {
  simulateScenario(input: {
    baseProductId: "prod_abc123"
    quantity: 100
    overrides: [
      { parameter: MATERIAL, value: "bio_based_composite" },
      { parameter: TRANSPORT_METHOD, value: "RAIL" },
      { parameter: ENERGY_SOURCE, value: "SOLAR" }
    ]
  }) {
    baseline {
      co2Equivalent
      mkiScore
    }
    simulated {
      co2Equivalent
      mkiScore
    }
    delta {
      co2Equivalent
      mkiScore
      percentageChange
    }
    equivalency {
      description
      value
    }
  }
}
Input:
FieldTypeRequiredDescription
baseProductIdID!YesProduct to use as baseline
quantityIntNoQuantity (default: 1)
overrides[ScenarioOverride!]!YesParameter overrides

​
ScenarioOverride

FieldTypeRequiredDescription
parameterScenarioParameter!YesParameter to override
valueString!YesNew value

​
ScenarioParameter enum

ValueDescription
MATERIALMaterial composition
TRANSPORT_METHODTransport type (TRUCK, RAIL, SHIP, AIR, ELECTRIC_TRUCK)
ENERGY_SOURCEEnergy source (GRID, SOLAR, WIND, HYDRO, NATURAL_GAS)
ORIGIN_COUNTRYISO country code
PACKAGINGPackaging material
RECYCLED_CONTENTRecycled content percentage (0-100)
END_OF_LIFEEnd-of-life scenario (LANDFILL, RECYCLE, INCINERATE, COMPOST)

​
simulateScenarios

Compare multiple scenarios side-by-side. 
mutation {
  simulateScenarios(input: {
    baseProductId: "prod_abc123"
    quantity: 100
    scenarios: [
      {
        name: "Bio-based + Rail"
        overrides: [
          { parameter: MATERIAL, value: "bio_based_composite" },
          { parameter: TRANSPORT_METHOD, value: "RAIL" }
        ]
      },
      {
        name: "Recycled + Electric"
        overrides: [
          { parameter: RECYCLED_CONTENT, value: "80" },
          { parameter: TRANSPORT_METHOD, value: "ELECTRIC_TRUCK" }
        ]
      },
      {
        name: "Full Green"
        overrides: [
          { parameter: MATERIAL, value: "bio_based_composite" },
          { parameter: TRANSPORT_METHOD, value: "RAIL" },
          { parameter: ENERGY_SOURCE, value: "SOLAR" },
          { parameter: RECYCLED_CONTENT, value: "90" }
        ]
      }
    ]
  }) {
    baseline { co2Equivalent mkiScore }
    results {
      name
      simulated { co2Equivalent mkiScore }
      delta { co2Equivalent mkiScore percentageChange }
      equivalency { description value }
    }
  }
}
For the full concept guide, see Scenario Simulator.