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
}
'import requests
url = "https://api-v2.production.higg.org/pic-api/v1/purchase-order-impacts-report"
payload = {
"from": 123,
"size": 123
}
headers = {
"x-api-key": "<api-key>",
"x-developer-request-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
'x-developer-request-token': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({from: 123, size: 123})
};
fetch('https://api-v2.production.higg.org/pic-api/v1/purchase-order-impacts-report', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-v2.production.higg.org/pic-api/v1/purchase-order-impacts-report",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'from' => 123,
'size' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-developer-request-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-v2.production.higg.org/pic-api/v1/purchase-order-impacts-report"
payload := strings.NewReader("{\n \"from\": 123,\n \"size\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-developer-request-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-v2.production.higg.org/pic-api/v1/purchase-order-impacts-report")
.header("x-api-key", "<api-key>")
.header("x-developer-request-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"from\": 123,\n \"size\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-v2.production.higg.org/pic-api/v1/purchase-order-impacts-report")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-developer-request-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"from\": 123,\n \"size\": 123\n}"
response = http.request(request)
puts response.read_body{
"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": {}
}
]
}Impact Reports
Get Purchase Order Impacts Report
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
}
'import requests
url = "https://api-v2.production.higg.org/pic-api/v1/purchase-order-impacts-report"
payload = {
"from": 123,
"size": 123
}
headers = {
"x-api-key": "<api-key>",
"x-developer-request-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
'x-developer-request-token': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({from: 123, size: 123})
};
fetch('https://api-v2.production.higg.org/pic-api/v1/purchase-order-impacts-report', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-v2.production.higg.org/pic-api/v1/purchase-order-impacts-report",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'from' => 123,
'size' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-developer-request-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-v2.production.higg.org/pic-api/v1/purchase-order-impacts-report"
payload := strings.NewReader("{\n \"from\": 123,\n \"size\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-developer-request-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-v2.production.higg.org/pic-api/v1/purchase-order-impacts-report")
.header("x-api-key", "<api-key>")
.header("x-developer-request-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"from\": 123,\n \"size\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-v2.production.higg.org/pic-api/v1/purchase-order-impacts-report")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-developer-request-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"from\": 123,\n \"size\": 123\n}"
response = http.request(request)
puts response.read_body{
"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
| Name | Type | Description |
|---|---|---|
from | number | [DEFAULT: 0] Pagination start index. |
size | number | [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.
⌘I

