Skip to main content

​
Search Parameters

To return all product data in the account, remove all the search parameters and use {}. All products will be returned. The following attributes can optionally be used to query the API. The products that meet all entered criteria will be returned. See the Scope 3 Data Dictionary—Product/Material Metadata for details about each search parameter.
  • Product ID
  • Product name
  • Product type
  • Product category
  • Created and edited dates
  • Product style/model number
  • Product barcode (UPC/EAN)
  • Account Worldly ID
  • Data source
  • Default product
To control the number of results returned and loop through the products, you can use the from and size fields. The from field tells the system which position to pull from. Note that the system starts at position 0. The ‘size’ determines how many products to return. You can also use the textSearch parameter to query off of inexact key words. For example, including “jacket” as a value will return all objects that include “jacket” in the name field. 
{
  "id": ["string"],
  "name": ["string"],
  "productType": [ "string"],
  "productCategory": ["string"],
  "barcodes": ["string"],
  "modelNumber": ["string"],
  "defaultProductId": ["string"],
  "importedProduct": true,
  "importedProductId": ["string"],
  "textSearch": ["string"],
  "from": 0,
  "size": 0
}

​
Search Results: Metadata

The following metadata about the product is returned in the results. Refer to the data dictionary for definitions of metadata fields. 
{
  "from": 0,
  "size": 0,
  "total": 0,
  "results": [
    {
      "_id": "string",
      "_rev": "string",
      "version": 0,
      "name": "string",
      "productType": "string",
      "productCategory": "string",
      "weightInformation": {
        "convertedToKg": 0,
        "weight": 0,
        "unit": "kilograms"
      },
      "modelNumber": "string",
      "barcodes": [
        "string"
      ],
      "dataSource": "string",
      "type": "string",
      "createdOn": 0,
      "modifiedOn": 0,
      "deleted": true,
      "modifiedBy": {
        "_id": "string",
        "email": "string"
      },
      "deletedBy": {
        "_id": "string",
        "email": "string"
      },
      "user": {
        "_id": "string",
        "email": "string"
      },
      "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
        }
      },
      "defaultProduct": {
        "defaultProductId": "string",
        "name": "string"
      }
    }
  ]
}

​
Search Results: Product Elements

Refer to the data dictionary for definitions of product element fields 
{     
		"materials": [
        {
          "name": "string",
          "netUse": 0,
          "materialId": "string",
          "composition": 0
        }
      ],
     "components": [
        {
          "name": "string",
          "componentId": "string",
          "unit": 0,
          "weightInformation": {
            "convertedToKg": 0,
            "weight": 0,
            "unit": "kilograms"
          }
        }
      ],
     "packaging": [
        {
          "name": "string",
          "packagingId": "string",
          "amount": 0,
          "weightInformation": {
            "convertedToKg": 0,
            "weight": 0,
            "unit": "kilograms"
          }
        }
      ],
     "upstreamTransportation": 0,
     "downstreamTransportationRetail": 0,
     "downstreamTransportationConsumer": 0,
     "distributionCenterUnOwned": 0,
     "retailEnergyUnOwned": 0,
     "notes": "string"
}

​
Search Results: Purchase Orders

Refer to the data dictionary for definitions of Purchase Order fields 
{     
"purchaseOrder": [
        {
          "_id": "string",
          "purchaseOrderId": "string",
          "purchaseDate": 0,
          "amountPurchase": 0,
          "assembly": {
            "isDefault": true,
            "femId": "string",
            "femDescriptor": "string"
          }
        }
      ]
}

​
Search Results: Total Impacts

Refer to the data dictionary for definitions of Impact fields 
      "purchaseOrderImpactsTotal": {
        "componentImpact": 0,
        "materialImpact": 0,
        "tier1Impact": 0,
        "packagingImpact": 0,
        "logisticsImpactsUpstreamTD": 0,
        "logisticsImpactsDTImpact": 0,
        "logisticsImpactsDCImpact": 0,
        "logisticsImpactsRetailImpact": 0,
        "productCareImpacts": 0,
        "endOfUseImpact": 0
      },
      "materialImpact": 0,
      "tier1Impact": 0,
      "packagingImpact": 0,
      "componentImpact": 0,
      "logisticsImpactsUpstreamTD": 0,
      "logisticsImpactsDTImpact": 0,
      "logisticsImpactsDCImpact": 0,
      "logisticsImpactsRetailImpact": 0,
      "productCareImpacts": 0,
      "endOfUseImpact": 0,
}