Skip to main content

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.

​
Search Parameters

Search for custom products from a Higg Index Product Module (PM) library that are available to import into the Scope 3 tool. You can search by name, type, category, ID, code or timestamp. 
{
  "ids": [
    "string"
  ],
  "accountId": "string",
  "name": "string",
  "productStyleNumber": "string",
  "productType": "Apparel",
  "productCategory": {},
  "createdAfter": "2023-06-27T04:26:45.750Z",
  "createdBefore": "2023-06-27T04:26:45.750Z",
  "lastEditedAfter": "2023-06-27T04:26:45.750Z",
  "lastEditedBefore": "2023-06-27T04:26:45.750Z",
  "platformModifiedBy": "User",
  "platformCreatedBy": "User",
  "productLastEditedBefore": "2023-06-27T04:26:45.750Z",
  "productLastEditedAfter": "2023-06-27T04:26:45.750Z",
  "submittedBefore": "2023-06-27T04:26:45.750Z",
  "submittedAfter": "2023-06-27T04:26:45.750Z",
  "barcodes": [
    "string"
  ]
}

​
Search Results

You will need the returned id in order to import the product into your Scope 3 library. If you modify any of these products through the Product Module, such as a Bill of Materials or metadata, you will need to reimport the product for it to be reflected in the Scope 3 library. 
{
  "from": 0,
  "size": 0,
  "total": 0,
  "results": [
    {
      "_id": "string",
      "created_on": 0,
      "last_edit": 0,
      "name": "string",
      "modelNumber": "string",
      "productType": "Apparel",
      "productCategory": {},
      "platformModifiedBy": "User",
      "platformCreatedBy": "User",
      "barcodes": [
        "string"
      ],
      "userEmail": "string",
      "draft": true,
      "grossWeight": 0,
      "productNetWeight": 0,
      "bomNetWeight": 0
    }
  ]
}