Skip to main content

Updating Products

The PM API provides functionality to update products via the API. See PM Data Dictionary for details about the parameters. The API uses the 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 product type and category are not editable via the API or manually in the Product Module tool. The user can update:
• Product name
• Product style/model number
• Bill of Materials—note that updating bill of materials completely overwrites all previously entered bill of materials information.
{
  "name": "test BoM 201",
  "productType": "Apparel",
  "productCategory": "Dress",
  "modelNumber": "test5",
  "packageMaterials":[{
    "_id": "samplepackage:PK012",
    "partName":"xyz package",
    "amount": 1,
    "measureUnit": "units"
  }],
  "trimMaterials":[{
    "_id": "sampletrim:TR001",
    "amount": 1,
    "measureUnit": "units"
  }],
  "baseMaterials":[{
    "_id": "TX0001",
    "amount": 1,
    "measureUnit": "kilograms"
  }],
  "customMaterials":[{
    "_id": "material:d68657bf-5c3e-472d-a4da-10c8d8e3614b",
    "amount": 1,
    "measureUnit": "kilograms"
  }]
}

Finding products update by user

A common use case is to search for products that have been manually updated by a user in Product Module, in order to pull the updated product impacts into the PLM. Users can search for “PlatformModifiedBy”: “User” to find products updated by users directly in PM. The “lastEditedAfter”: 0 and “lastEditedBefore”: 0 search parameters can be used to set the date period to search for edits.
{
    "platformModifiedBy": "User",
    "lastEditedAfter": "2021-01-13T16:38:19.386Z",
    "lastEditedBefore": "2021-12-13T20:38:19.386Z"
}