Skip to main content
POST
/
purchase-order-impacts-report
Get Purchase Order Impacts Report
curl --request POST \
  --url https://api-v2.production.higg.org/pic-api/v1/purchase-order-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": [
    {
      "accountId": "<string>",
      "productId": "<string>",
      "productName": "<string>",
      "type": "<string>",
      "category": "<string>",
      "productWeightKg": 123,
      "totalWeight": 123,
      "dataSource": "<string>",
      "tags": "<string>",
      "createdBy": "<string>",
      "createdOn": "<string>",
      "modifiedBy": "<string>",
      "modifiedOn": "<string>",
      "idType": "<string>",
      "id": "<string>",
      "poNumber": "<string>",
      "poDate": "<string>",
      "quantity": 123,
      "tier1Supplier": "<string>",
      "femStatus": "<string>",
      "cat1PurchasedGoodsMaterialsImpactsKgCO2eq": {},
      "cat1PurchasedGoodsComponentsImpactsKgCO2eq": {},
      "cat1PurchasedGoodsFinalAssemblyImpactsKgCO2eq": {},
      "cat1PurchasedGoodsPackagingImpactsKgCO2eq": {},
      "cat4UpstreamTransportationKgCO2eq": {},
      "cat9DownstreamTransportationKgCO2eq": {},
      "cat9DownstreamDistributionCenterKgCO2eq": {},
      "cat9DownstreamRetailKgCO2eq": {},
      "cat11UseOfSoldProductsKgCO2eq": {},
      "cat12EndOfLifeTreatmentKgCO2eq": {},
      "impactPerUnit": {},
      "totalImpact": {},
      "duplicate": {}
    }
  ]
}
Use this endpoint to generate a Scope 3 impact report grouped by product and purchase order. Each row in the report represents a purchase order with its calculated environmental impact across multiple categories.

​
Request body params

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

​
Implementation Details

  • Product-level pagination: Results are paginated by product, sorted by name. Each product may contain multiple purchase order rows.
  • Impact categories: Each row includes Scope 3 impact data for materials, components, packaging, logistics, use phase, and end of life.
  • Prerequisite: Products must have calculated impacts. Use Recalculate Products or Recalculate Purchase Orders 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