Carbonlink API
  • 🌿Welcome to Carbonlink
  • 🌟How Carbonlink Works
  • πŸ’ΎInstallation
  • ⁉️Handling Errors & Limits
    • Response Codes
    • Rate Limiting
  • GUIDES
    • Use Cases
      • E-Commerce
      • Carbon Accounting
      • Carbon Solution Providers
  • CORE
    • πŸ“–API reference
      • πŸ‘œProduct
      • 🧩Factor
      • πŸ—ΊοΈAsset
      • 🌍Offset
      • 🚞Estimate
    • πŸ“¦Data objects
      • Factor
      • Product
      • Asset
        • Project
          • Vintage
        • Pool
      • Estimate
      • Offset
  • Resources
    • Defining Emissions
      • The Scope System
      • CO2 Equivalents
    • Carbon Markets 101
      • What is A Carbon Credit?
      • Environmental Impact of Offsetting
      • How Are Credits Generated & Verified?
    • Methodologies
      • Carbon Credit Methodologies
      • Estimate Methodology
Powered by GitBook
On this page
  1. CORE
  2. Data objects

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

// 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,
}
PreviousFactorNextAsset

Last updated 1 year ago

Whether this product can be used when creating an

πŸ“¦
Estimate