Skip to main content
Products are the things you sell, and Materials are made in-house or sourced from a Supplier.
API documentation: Product , Material

​
Attributes

AttributeTypeDescriptionExample
uuidstringThe unique identifier123e4567-e89b-12d3-a456-426614174000
namestringThe name of the materialSteel
skustringThe stock keeping unitST123
unitUnitThe unit of measurekg
weightAmountThe weight of the material{ quantity: 100, unit: "kg" }
startDatedateThe date the model is valid from2021-01-01
endDatedateThe date the model is valid until2021-12-31
dataQualityIndicatorsobjectInformation about the quality of the material{ technologicalDQR: 2, ... }
dataQualityRatingnumberA number from 1 to 3 representing the quality of the material1
TaxonomyTaxonomyThe category of the materialSteel
GeoLocationGeoLocationThe location of the materialPittsburgh, PA
LocationLocationThe named location of the materialPittsburgh Warehouse
DataSourceDataSourceThe source of the data[{ name: "ecoinvent" }]
createddateThe date the material was created2021-01-01T00:00:00.000Z
updateddateThe date the material was last updated2021-01-22T00:00:00.000Z

​
Data Quality

Both of these follow the Pathfinder framework, with some additional fields on the dataQualityIndicators object. The dataQualityIndicators object contains information about the quality of the material. 
{
  "documentationYear": 2022,
  "coveragePercent": 100,
  "specificPercent": 0,
  "averagePercent": 100,
  "technologicalDQR": 2,
  "temporalDQR": 2,
  "geographicalDQR": 2,
  "completenessDQR": 1,
  "reliabilityDQR": 1
}
The dataQualityRating is a number from 1 to 3 that represents the quality of the material (1 being the best). 
{
  "dataQualityRating": 1
}

​
Footprint

The footprints.CO2e object holds the CO2e values for the Product / Material. 
{
  "CO2e": {
    "totalCarbonFootprint": "1234.5678",
    "productCarbonFootprint": "1234.0",
    "upstream": "1230.0",
    "direct": "4.0",
    "downstream": "0.0678",
    "A1_A3": "1234.0",
    "A1": "1200.0",
    "A2": "30.0",
    "A3": "4.0",
    "A4": "0.5",
    "B1": "0.06",
    "B2": "0.007",
    "B3": "0.0008",
    "B4": "",
    "B5": "",
    "C1": "",
    "C2": "",
    "C3": "",
    "C4": "",
    "D": ""
  }
}

​
Diagram