Skip to main content
GET
/
v1
/
sold-products
/
{sold_product_id}
/
periods
/
{period_id}
/
emissions
Period Emissions
const options = {
  method: 'GET',
  headers: {'x-api-key': '<x-api-key>', 'x-organization-id': '<x-organization-id>'}
};

fetch('https://api.dcycle.io/v1/sold-products/{sold_product_id}/periods/{period_id}/emissions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "items": {
    "type": "<string>",
    "status": "<string>",
    "quantity": {},
    "has_missing_impacts": true,
    "use_of_product_data_id": {}
  }
}

Period Emissions

Retrieve the emissions breakdown for a specific sold product period. Returns downstream emissions calculated for Scope 3 Category 11 (Use of Sold Products), including use-phase and end-of-life emissions.

Request

Headers

x-api-key
string
required
Your API key for authenticationExample: sk_live_1234567890abcdef
x-organization-id
string
required
Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Path Parameters

sold_product_id
string
required
UUID of the sold productExample: "550e8400-e29b-41d4-a716-446655440000"
period_id
string
required
UUID of the periodExample: "11111111-1111-1111-1111-111111111111"

Response

Returns a list of emission entries by type (HTTP 200).
items
array[object]
List of emission entries.

Example

curl -X GET "https://api.dcycle.io/v1/sold-products/550e8400-e29b-41d4-a716-446655440000/periods/11111111-1111-1111-1111-111111111111/emissions" \
  -H "x-api-key: ${DCYCLE_API_KEY}" \
  -H "x-organization-id: ${DCYCLE_ORG_ID}"

Successful Response

{
  "items": [
    {
      "type": "use_phase",
      "status": "calculated",
      "quantity": 12500.0,
      "has_missing_impacts": false,
      "use_of_product_data_id": "data-uuid-001"
    },
    {
      "type": "end_of_life",
      "status": "calculated",
      "quantity": 350.0,
      "has_missing_impacts": false,
      "use_of_product_data_id": null
    }
  ]
}

Common Errors

401 Unauthorized

Cause: Missing or invalid API key
{"detail": "Invalid API key for organization", "code": "INVALID_API_KEY"}

403 Forbidden

Cause: The authenticated user is not a member of the organization
{"detail": "Logged User is not Member of Organization", "code": "LOGGED_USER_NOT_MEMBER"}

404 Not Found

Cause: The sold product or period does not exist or belongs to another organization
{"detail": "Not Found"}

Period Country Sales

View country-level sales for this period

Emissions Summary

Get aggregated emissions across all categories