Skip to main content

​
Search Parameters

Search for custom materials, components, and packaging from a Higg Index Materials (MSI) library that are available to import into the Scope 3 tool. You can search by name, type, ID, code or timestamp. Note that only custom objects will be eligible for import, not example objects within the Higg MSI library. 
{
  "ids": [
    "string"
  ],
  "code": [
    "string"
  ],
  "name": "string",
  "text": "string",
  "type": "material",
  "createdAfter": "2023-06-20T18:08:42.672Z",
  "createdBefore": "2023-06-20T18:08:42.672Z",
  "lastEditedAfter": "2023-06-20T18:08:42.672Z",
  "lastEditedBefore": "2023-06-20T18:08:42.672Z",
  "platformModifiedBy": "User",
  "platformCreatedBy": "User",
  "from": 0,
  "size": 0
}

​
Search Results

You will need the returned id in order to import the material, component and/or packaging into your Scope 3 library. If you modify any of these objects in the MSI library, such as material composition or metadata, you will need to reimport the object for it to be reflected in the Scope 3 library. 
{
  "from": 0,
  "size": 0,
  "total": 0,
  "results": [
    {
      "_id": "string",
      "type": "material",
      "sample": true,
      "draft": false,
      "created": 0,
      "lastEdited": 0,
      "name": "string",
      "code": "string",
      "partNumber": "string",
      "productNumber": "string",
      "category": "string",
      "vendor": "string",
      "platformCreatedBy": "User",
      "platformModifiedBy": "User",
      "userEmail": "string",
      "sharedBy": {
        "accountName": "string",
        "accountId": "string",
        "sacId": 0,
        "oarId": "string",
        "taxId": "string",
        "customIds": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        }
      },
      "description": "string"
    }
  ]
}