Skip to main content
POST
/
material-library
/
material-list
cURL
curl --request POST \
  --url https://api-v2.production.higg.org/pic-api/v1/material-library/material-list \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-developer-request-token: <api-key>' \
  --data '
{
  "filter": {
    "logic": "<string>",
    "filters": [
      {
        "field": "<string>",
        "operator": "<string>",
        "value": {}
      }
    ]
  },
  "skip": 123,
  "take": 123,
  "sort": [
    {
      "field": "<string>",
      "dir": "<string>",
      "isNotNested": true
    }
  ],
  "searchStr": "<string>"
}
'
{
  "total": 123,
  "hits": [
    {
      "_id": "<string>",
      "type": "<string>",
      "name": "<string>",
      "t2GlobalWarmingImpact": 123,
      "t3GlobalWarmingImpact": 123,
      "t4GlobalWarmingImpact": 123,
      "createdOn": 123,
      "user": {
        "_id": "<string>",
        "email": "<string>",
        "firstname": "<string>",
        "lastname": "<string>"
      },
      "account": {
        "_id": "<string>",
        "name": "<string>",
        "country": "<string>",
        "sacId": 123,
        "oar_id": "<string>",
        "demoaccount": true,
        "socialCreditId": "<string>",
        "taxId": "<string>",
        "bluesignId": "<string>",
        "zdhcId": "<string>",
        "ipeViolation": {
          "totalViolations": 123
        },
        "ffcId": 123
      },
      "totalMaterialGlobalWarmingImpact": 123,
      "_rev": "<string>",
      "code": "<string>",
      "category": "<string>",
      "supplierCountry": "<string>",
      "nameId": "<string>",
      "supplier": "<string>",
      "country": "<string>",
      "tier2": {
        "isDefault": true,
        "assessment": {
          "_id": "<string>",
          "surveyVersion": "<string>",
          "country": "<string>",
          "processName": "<string>"
        },
        "facility": {
          "_id": "<string>",
          "name": "<string>",
          "country": "<string>",
          "sacId": 123,
          "oar_id": "<string>",
          "demoaccount": true,
          "socialCreditId": "<string>",
          "taxId": "<string>",
          "bluesignId": "<string>",
          "zdhcId": "<string>",
          "ipeViolation": {
            "totalViolations": 123
          },
          "ffcId": 123
        },
        "country": "<string>",
        "facilityRawText": "<string>"
      },
      "tier3": {
        "isDefault": true,
        "assessment": {
          "_id": "<string>",
          "surveyVersion": "<string>",
          "country": "<string>",
          "processName": "<string>"
        },
        "facility": {
          "_id": "<string>",
          "name": "<string>",
          "country": "<string>",
          "sacId": 123,
          "oar_id": "<string>",
          "demoaccount": true,
          "socialCreditId": "<string>",
          "taxId": "<string>",
          "bluesignId": "<string>",
          "zdhcId": "<string>",
          "ipeViolation": {
            "totalViolations": 123
          },
          "ffcId": 123
        },
        "country": "<string>",
        "facilityRawText": "<string>"
      },
      "baseMaterials": [
        {
          "_id": "<string>",
          "composition": 123,
          "name": "<string>",
          "baseMaterialProcesses": [
            {
              "_id": "<string>",
              "name": "<string>",
              "stageName": "<string>",
              "lifeCycle": "<string>",
              "isEligible": true,
              "totalMaterialGlobalWarmingImpact": 123,
              "totalLossRate": 123,
              "residualElectricityTotal": 123,
              "lossRate": 123,
              "assessment": {
                "_id": "<string>",
                "surveyVersion": "<string>",
                "country": "<string>",
                "processName": "<string>"
              },
              "facility": {
                "_id": "<string>",
                "name": "<string>",
                "country": "<string>",
                "sacId": 123,
                "oar_id": "<string>",
                "demoaccount": true,
                "socialCreditId": "<string>",
                "taxId": "<string>",
                "bluesignId": "<string>",
                "zdhcId": "<string>",
                "ipeViolation": {
                  "totalViolations": 123
                },
                "ffcId": 123
              },
              "country": "<string>",
              "facilityType": [
                "<string>"
              ],
              "sipfacilitymaterialprocesstextiles": [
                "<string>"
              ],
              "materialproduction_normalized_kgco2e": 123,
              "rawmaterialprocessing_normalized_kgco2e": 123,
              "globalWarmingImpact": 123,
              "facilityRawText": "<string>"
            }
          ],
          "totalMaterialGlobalWarmingImpactT2": 123,
          "totalMaterialGlobalWarmingImpactT3": 123,
          "totalMaterialGlobalWarmingImpactT4": 123,
          "totalMaterialGlobalWarmingImpact": 123,
          "refKey": "<string>",
          "sustainability": {
            "isEligible": true,
            "processId": "<string>"
          },
          "baseMaterialProcessesList": [
            {
              "_id": "<string>",
              "name": "<string>",
              "stageName": "<string>",
              "lifeCycle": "<string>",
              "isEligible": true,
              "totalMaterialGlobalWarmingImpact": 123,
              "totalLossRate": 123,
              "residualElectricityTotal": 123,
              "lossRate": 123,
              "assessment": {
                "_id": "<string>",
                "surveyVersion": "<string>",
                "country": "<string>",
                "processName": "<string>"
              },
              "facility": {
                "_id": "<string>",
                "name": "<string>",
                "country": "<string>",
                "sacId": 123,
                "oar_id": "<string>",
                "demoaccount": true,
                "socialCreditId": "<string>",
                "taxId": "<string>",
                "bluesignId": "<string>",
                "zdhcId": "<string>",
                "ipeViolation": {
                  "totalViolations": 123
                },
                "ffcId": 123
              },
              "country": "<string>",
              "facilityType": [
                "<string>"
              ],
              "sipfacilitymaterialprocesstextiles": [
                "<string>"
              ],
              "materialproduction_normalized_kgco2e": 123,
              "rawmaterialprocessing_normalized_kgco2e": 123,
              "globalWarmingImpact": 123,
              "facilityRawText": "<string>"
            }
          ],
          "uniqueCyclesAssessments": [
            {
              "assessmentId": "<string>",
              "processId": "<string>",
              "lifeCycle": "<string>",
              "isEligible": true,
              "sipfacilitymaterialprocesstextiles": "<string>"
            }
          ]
        }
      ],
      "modifiedOn": 123,
      "deleted": true,
      "deletedBy": {
        "_id": "<string>",
        "email": "<string>",
        "firstname": "<string>",
        "lastname": "<string>"
      },
      "modifiedBy": {
        "_id": "<string>",
        "email": "<string>",
        "firstname": "<string>",
        "lastname": "<string>"
      },
      "createdBy": {
        "_id": "<string>",
        "email": "<string>",
        "firstname": "<string>",
        "lastname": "<string>"
      },
      "msiVersion": "<string>"
    }
  ],
  "max_score": 123,
  "aggregations": {}
}

Documentation Index

Fetch the complete documentation index at: https://developer.worldly.io/llms.txt

Use this file to discover all available pages before exploring further.

Use this endpoint to list and search the custom materials in your PIC material library. This returns materials that you have created or imported, not the default BOM catalog.
For the default BOM material catalog used when building product compositions, use Get Materials (Product Attributes) instead.

​
Implementation Details

  • Your materials only: Returns materials belonging to your account’s material library.
  • Searchable: Supports text search and standard filtering parameters (skip, take, sort, filter) for advanced queries.

Authorizations

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

Body

application/json
​
filter
object
​
skip
number<double> | null
​
take
number<double> | null
​
sort
object[] | null
​
searchStr
string | null

Response

200 - application/json

Ok

​
total
number<double>
required
​
hits
object[]
required
​
max_score
number<double> | null
​
aggregations
object