Skip to content

Update an existing product Record

Request

Update an existing Product record to the system based on the provided Product details.

Security
Bearer
Bodyapplication/jsonrequired

The Product payload

idstring, (uuid)

Gets or sets the unique identifier of the product outflow record.

Example:"6fa85f64-5717-4562-b3fc-2c963f66afa6"
productIdstring or null

Gets or sets the product identifier or code.

Example:"PRD001"
namestring, non-emptyrequired

Gets or sets the name of the product.

Example:"Laptop Model X"
companyIdinteger, (int32)required

Company identifier associated with the product. Retrieve it from the Company GET API and use the ID value returned in the response.

Example:101
companyNamestring or null

Gets or sets the company name.

Example:"ABC Manufacturing Pvt Ltd"
businessUnitIdinteger or null, (int32)

Business unit identifier associated with the product. Retrieve it from the BusinessUnit GET API and use the ID value returned in the response.

Example:10
businessUnitNamestring or null

Gets or sets the business unit name.

Example:"Electronics Division"
productCategoryIdstring or null, (uuid)

Product category identifier. Retrieve it from the ProductCategory/Paged endpoint (POST) and use the product category ID value returned in the response.

Example:"3fa85f64-5717-4562-b3fc-2c963f66afa6"
productCategoryNamestring or null

Gets or sets the product category name.

Example:"Electronics"
productGroupIdstring or null, (uuid)

Product group identifier. Retrieve it from the ProductGroup/Paged endpoint (POST) and use the product group ID value returned in the response.

Example:"4ab12f64-1234-4562-b3fc-2c963f66abcd"
productGroupNamestring or null

Gets or sets the product group name.

Example:"Consumer Devices"
productTypeIdstring or null, (uuid)

Product type identifier. Retrieve it from the ProductType/Paged endpoint (POST) and use the product type ID value returned in the response.

Example:"9cd85f64-2222-4562-b3fc-2c963f66eeee"
productTypeNamestring or null

Gets or sets the product type name.

Example:"Laptops"
productDescriptionstring or null

Gets or sets the detailed description of the product.

Example:"High-performance business laptop with 16GB RAM and 512GB SSD."
curl -i -X PUT \
  https://developer.sustainabilitymaster.ai/_mock/openapi/api/EnterpriseTables/Product \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "6fa85f64-5717-4562-b3fc-2c963f66afa6",
    "productId": "PRD001",
    "name": "Laptop Model X",
    "companyId": 101,
    "companyName": "ABC Manufacturing Pvt Ltd",
    "businessUnitId": 10,
    "businessUnitName": "Electronics Division",
    "productCategoryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "productCategoryName": "Electronics",
    "productGroupId": "4ab12f64-1234-4562-b3fc-2c963f66abcd",
    "productGroupName": "Consumer Devices",
    "productTypeId": "9cd85f64-2222-4562-b3fc-2c963f66eeee",
    "productTypeName": "Laptops",
    "productDescription": "High-performance business laptop with 16GB RAM and 512GB SSD."
  }'

Responses

Successfully added the Product record