Product

Contains data related to the estimation of a good or service's emissions from a set of underlying emission factors.

The Product object

id string

Unique identifier for the object

name string

The name of the product

rate float

Emission rate per product unit

skus string

Comma-separated list of Product SKUs or other internal identifiers

shippable boolean

Whether this product has shipping emissions

factors object

Object containing an array of one or more Product Factor objects. Note: A Product Factor object is defined as follows:

{

factorId: "...",

value: 1.2

} The value attribute of the Product Factor object is quantity applied to the rate attribute of the Factor corresponding to factorId.

updatedAt string

Time of Product update

createdAt object

Time of Product creation

active boolean

Whether this product can be used when creating an Estimate

// Example:
{
  id: "prod_12345678",
  name: "Road Bike - 2023 Model",
  kgCO2e: 123.45,
  shippable: true,
  sector: 'Ground Transportation',
  category: "Bicycle",
  factors: [
    {
        factorId: "fct_123...",
        value: 1.23
    },
    {
        factorId: "fct_456...",
        value: 34.51
    },
    ...
  ],
  active: true,
}

Last updated