Create Energy
Create a new energy element
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
"Product Name"
"A descriptive description"
"Internal notes about this product"
"SKU123"
"CPC123"
The unit code (e.g. kg, lbs, etc.). All unit codes can be found in the List Units endpoint.
"kg"
The user-declared weight of the product. On read responses, compare with the server-computed modeledWeight to mass-balance the product against its bill of materials.
The user-declared weight of the product's packaging. On read responses, compare with the server-computed modeledPackagingWeight to mass-balance packaging against its bill of materials.
The user-declared recycled content of the product as a percentage (0–100). A 0 is a declared zero; omit the field when undeclared. On read responses, compare with the server-computed modeledRecycledPercent.
30
Using dataSource: external allows setting certain footprint.CO2e values. The values are computed all other dataSources.
A reference to a taxonomy category, including its machine-readable path.
ISO 8601 date
"2021-01-01T00:00:00.000Z"
ISO 8601 date
"2021-01-01T00:00:00.000Z"
model, external "model"
Response
An energy element
"Grid electricity"
"A descriptive description"
"Internal notes about this product"
"SKU123"
"CPC123"
The unit code (e.g. kg, lbs, etc.). All unit codes can be found in the List Units endpoint.
"kg"
The user-declared weight of the product. On read responses, compare with the server-computed modeledWeight to mass-balance the product against its bill of materials.
The user-declared weight of the product's packaging. On read responses, compare with the server-computed modeledPackagingWeight to mass-balance packaging against its bill of materials.
The user-declared recycled content of the product as a percentage (0–100). A 0 is a declared zero; omit the field when undeclared. On read responses, compare with the server-computed modeledRecycledPercent.
30
Deprecated — use impacts["GWP-fossil"]. Kept for backwards compatibility.
A reference to a taxonomy category, including its machine-readable path.
ISO 8601 date
"2021-01-01T00:00:00.000Z"
ISO 8601 date
"2021-01-01T00:00:00.000Z"
model, external "model"
"https://app.variable.global/uploads/image.jpg"
Read-only. Server-computed sum of the model's A1–A3 product material
input weights (Material group "Product"; excludes packaging and
ancillary), in the same Amount shape as the declared weight. Compare
the two to mass-balance the product: weight is the value you set, while
modeledWeight is derived from the bill of materials. Present only when
the model has qualifying product inputs. Ignored on POST/PATCH.
Read-only. Server-computed sum of the model's A1–A3 packaging input
weights (Material group "Packaging"), in the same Amount shape as the
declared packagingWeight. Compare the two to mass-balance packaging:
packagingWeight is the value you set, while modeledPackagingWeight is
derived from the bill of materials. Present only when the model has
qualifying packaging inputs. Ignored on POST/PATCH.
Read-only. Gross modeled weight: the sum of modeledWeight and
modeledPackagingWeight, in the same Amount shape. Derived at read
time from the two persisted addends — a missing addend contributes
nothing — so it's present whenever at least one of the two is present;
its unit follows the first present addend. Ignored on POST/PATCH.
Read-only. Server-computed weight-weighted average of the contributing
inputs' recycled content (0–100). Compare against the declared
recycledPercent: recycledPercent is the value you set, while
modeledRecycledPercent is derived from the bill of materials. Present only
when the model has contributing inputs. Ignored on POST/PATCH.
27.5
Environmental impact indicators keyed by canonical code (e.g. GWP-fossil, ODP, AP). Which indicators appear is controlled by the impacts query parameter — by default only GWP-fossil is returned.
{
"GWP-fossil": {
"unit": "kgCO2e",
"method": "Mixed",
"totalCarbonFootprint": "10",
"A1_A3": "10"
},
"ODP": {
"unit": "kgCFC11e",
"method": "EN15804+A2 - Core impact categories and indicators",
"A1_A3": "0.0000012"
},
"AP": {
"unit": "molH+e",
"method": "EN15804+A2 - Core impact categories and indicators",
"A1_A3": "2"
}
}1.4
ISO 8601 date
"2021-01-01T00:00:00.000Z"
ISO 8601 date
"2021-01-31T23:59:59.000Z"