Skip to main content

​
Create a Product

When creating a product, at least a product name and default product are required values. Optionally, you can include the following parameters:
  • Model number and barcodes
  • Base materials along with their blend percentage composition and net use
  • Packaging, components and product weight (kilograms)
  • Percentage of unowned upstream/downstream transportation, distribution center and retail energy
{
  "name": "string",
  "defaultProduct": "string",
  "modelNumber": "string",
  "barcodes": [
    "string"
  ],
  "weight": 0,
  "weightMeasureUnit": "kilograms",
  "notes": "string",
  "packaging": [
    {
      "packagingId": "string",
      "amount": 0
    }
  ],
  "components": [
    {
      "componentId": "string",
      "unit": "string"
    }
  ],
  "materials": [
    {
      "netUse": 0,
      "materialId": "string",
      "composition": 0
    }
  ],
  "upstreamTransportation": 0,
  "downstreamTransportationRetail": 0,
  "downstreamTransportationConsumer": 0,
  "distributionCenterUnOwned": 0,
  "retailEnergyUnOwned": 0
}
Be sure to use the default product endpoint to get a list of available values to include in the required parameter when creating your product

​
Add Purchase Orders

Purchase orders can be included with product creation. A purchase date and purchase amount are required. Optionally, the ID of a FEM module can be included if the purchase order is attributed to a specific supply chain facility. Otherwise default Tier 1 (final assembly) emissions will be used. 
{
  "addPurchaseOrder": [
    {
      "purchaseOrderId": "string",
      "purchaseDate": "string",
      "amountPurchase": 0,
      "femId": "string"
    }
  ]
}
Note that you cannot link FEM modules with products that were imported from the Higg Index Product Module. Only products created in the Scope 3 tool can be linked to FEMs. Imported products will use the default final assembly emissions in their Scope 3 calculations