API documentation: Product , Material , Database search
Attributes
| Attribute | Type | Description | Example |
|---|---|---|---|
| uuid | string | The unique identifier | 123e4567-e89b-12d3-a456-426614174000 |
| name | string | The name of the material | Steel |
| sku | string | The stock keeping unit | ST123 |
| unit | Unit | The unit of measure | kg |
| weight | Amount | The user-declared weight of the material | { quantity: 100, unit: "kg" } |
| packagingWeight | Amount | The user-declared weight of the material’s packaging | { quantity: 10, unit: "kg" } |
| modeledWeight | Amount | Read-only. Server-computed sum of the model’s A1–A3 product material input weights (Material group “Product”; excludes packaging and ancillary) | { quantity: 100, unit: "kg" } |
| modeledPackagingWeight | Amount | Read-only. Server-computed sum of the model’s A1–A3 packaging input weights (Material group “Packaging”); compare against the declared packagingWeight | { quantity: 12.5, unit: "kg" } |
| modeledTotalWeight | Amount | Read-only. Gross modeled weight: modeledWeight + modeledPackagingWeight, derived at read time (a missing addend contributes nothing); present when at least one of the two is present | { quantity: 112.5, unit: "kg" } |
| recycledPercent | number | The user-declared recycled content of the material as a percentage (0–100). A 0 is a declared zero; absent when undeclared | 30 |
| modeledRecycledPercent | number | Read-only. Server-computed weight-weighted average of the contributing inputs’ recycled content (0–100); compare against the declared recycledPercent | 27.5 |
| startDate | date | The date the model is valid from | 2021-01-01 |
| endDate | date | The date the model is valid until | 2021-12-31 |
| dataQualityIndicators | object | Information about the quality of the material | { technologicalDQR: 2, ... } |
| dataQualityRating | number | A number from 1 to 3 representing the quality of the material | 1 |
| taxonomy | Taxonomy | The category of the material | Steel |
| geoLocation | GeoLocation | The location of the material | Pittsburgh, PA |
| location | Location | The named location of the material | Pittsburgh Warehouse |
| dataSources | DataSource | The source of the data | [{ name: "ecoinvent" }] |
| created | date | The date the material was created | 2021-01-01T00:00:00.000Z |
| updated | date | The date the material was last updated | 2021-01-22T00:00:00.000Z |
Data Quality
Both of these follow the Pathfinder framework, with some additional fields on thedataQualityIndicators object.
The dataQualityIndicators object contains information about the quality of the material.
dataQualityRating is a number from 1 to 3 that represents the quality of the material (1 being the best).
Footprint
Thefootprint.CO2e object holds the CO2e values for the Product / Material.