Skip to main content

​
Search Parameters

This endpoint can be used to search for materials, components and packaging within a Scope 3 library, as indicated by the type parameter. You can also search for materials, components and packaging that have been imported from a Higg Index Materials (MSI) library, as indicated by the boolean imported parameter. 
{
  "from": 0,
  "size": 0,
  "ids": [
    "string"
  ],
  "textSearch": "string",
  "type": [
    "material"
  ],
  "name": [
    "string"
  ],
  "code": [
    "string"
  ],
  "category": [
    "string"
  ],
  "imported": true
}

​
Search Results

In addition to the metadata, the response will also return data source and version values. The data source will indicate whether the material, component or packaging was created in the Scope 3 tool or imported from the Higg Index Materials (MSI) library. The version number will indicate the applicable version based on the data source. 
{
  "from": 0,
  "size": 0,
  "total": 0,
  "results": [
    {
      "_id": "string",
      "_rev": "string",
      "type": "material",
      "name": "string",
      "description": "string",
      "vendor": "string",
      "createdOn": 0,
      "modifiedOn": 0,
      "account": {
        "_id": "string",
        "name": "string",
        "country": "string",
        "sacId": 0,
        "oar_id": "string",
        "demoaccount": true,
        "vbType": "None",
        "socialCreditId": "string",
        "taxId": "string",
        "bluesignId": "string",
        "zdhcId": "string",
        "ipeViolation": {
          "totalViolations": 0
        }
      },
      "dataSource": "string",
      "version": "string",
      "code": "string",
      "defectRate": 0,
      "weightInformation": {
        "convertedToKg": 0,
        "weight": 0,
        "unit": "kilograms"
      },
      "impacts": {
        "tier4Impact": 0,
        "tier2and3Impact": 0,
        "totalTierImpact": 0
      },
      "category": "string",
      "deleted": true,
      "visibleForAccounts": [
        "string"
      ],
      "imported": true
    }
  ]
}