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.

The API uses the individual product ID to identify the product to update. The user can then optionally send the following information to update the product. Only the parameters sent via the update are updated. Note that the default product is not editable via the API and must be edited manually in the Scope 3 tool. The user can update:
  • Product name
  • Model/style number, barcodes and weight
  • Materials, packaging and components
  • Percentage of unowned upstream/downstream transportation, distribution center and retail energy
  • Purchase orders
Additionally, purchase orders can be deleted from a product using the removePurchaseOrder parameter. 
{
  "modelNumber": "string",
  "barcodes": [
    "string"
  ],
  "name": "string",
  "weight": 0,
  "weightMeasureUnit": "kilograms",
  "notes": "string",
  "packaging": [
    {
      "packagingId": "string",
      "amount": 0
    }
  ],
  "materials": [
    {
      "netUse": 0,
      "materialId": "string",
      "composition": 0
    }
  ],
  "components": [
    {
      "componentId": "string",
      "unit": 0
    }
  ],
  "upstreamTransportation": 0,
  "downstreamTransportationRetail": 0,
  "downstreamTransportationConsumer": 0,
  "distributionCenterUnOwned": 0,
  "retailEnergyUnOwned": 0,
  "addPurchaseOrder": [
    {
      "purchaseOrderId": "string",
      "purchaseDate": "string",
      "amountPurchase": 0,
      "femId": "string"
    }
  ],
  "removePurchaseOrder": [
    "string"
  ]
}