Skip to main content
POST
/
materials-impacts-report
Get Materials Impacts Report
curl --request POST \
  --url https://api-v2.production.higg.org/pic-api/v1/materials-impacts-report \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-developer-request-token: <api-key>' \
  --data '
{
  "from": 123,
  "size": 123
}
'
{
  "from": 123,
  "size": 123,
  "total": 123,
  "results": [
    {
      "productName": "<string>",
      "productType": "<string>",
      "category": "<string>",
      "productId": "<string>",
      "quantity": 123,
      "poDate": "<string>",
      "poNumber": "<string>",
      "name": "<string>",
      "type": "<string>",
      "id": "<string>",
      "code": "<string>",
      "dataSource": "<string>",
      "materialNetUsePercent": 123,
      "materialBomPercent": 123,
      "weightPerProductKg": 123,
      "totalWeightKg": 123,
      "unitsPerProduct": {},
      "totalUnits": {},
      "impactPerProductKgCo2e": 123,
      "totalImpactKgCo2e": 123,
      "description": "<string>"
    }
  ]
}
Use this endpoint to generate a detailed impact report broken down by individual materials, components, packaging, and assembly processes. This provides a granular view of each element’s contribution to a product’s environmental footprint.

​
Request body params

Field NameData TypeDescription
fromnumber[DEFAULT: 0] Pagination start index.
sizenumber[DEFAULT: 50] Number of results to return.

​
Implementation Details

  • Product-level pagination: Results are paginated by product. Each product expands into multiple rows — one per material, component, packaging item, and assembly process.
  • BOM detail: Each row includes the specific BOM element (material name, composition, weight) alongside its calculated impact values.
  • Prerequisite: Products must have calculated impacts. Use Recalculate Products if impacts are out of date.

Authorizations

​
x-api-key
string
header
required
​
x-developer-request-token
string
header
required

Body

application/json
​
from
number<double> | null
​
size
number<double> | null

Response

200 - application/json

Ok

API Search responses

​
from
number<double>
required
​
size
number<double>
required
​
total
number<double>
required
​
results
object[]
required