Update an existing StockKeepingUnit Record

Request

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

Security

Bearer

Bodyapplication/jsonrequired

The StockKeepingUnit payload

idstring, (uuid)

Gets or sets the unique identifier of the SKU.

Example:"3fa85f64-5717-4562-b3fc-2c963f66afa6"

skuidstring, non-emptyrequired

Gets or sets the SKU identifier or code.

Example:"SKU001"

productIdstring, (uuid)required

Identifier of the product associated with the SKU. Retrieve it from the Product/Paged endpoint (POST) and use the product ID value returned in the response.

Example:"9fa85f64-5717-4562-b3fc-2c963f66abcd"

productNamestring or null

Gets or sets the associated product name.

Example:"Laptop Model X"

companyIdinteger or null, (int32)

Company identifier associated with the SKU. 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 name of the company associated with the SKU.

Example:"ABC Corporation"

businessUnitIdinteger or null, (int32)

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

Example:101

businessUnitNamestring or null

Gets or sets the name of the business unit associated with the SKU.

Example:"Consumer Electronics"

namestring or null

Gets or sets the SKU name.

Example:"Laptop Model X - 16GB"

countryOfOriginIdinteger or null, (int32)

Country of origin identifier of the SKU. Retrieve it from the Country GET API and use the ID value returned in the response.

Example:110

countryOfOriginNamestring or null

Country of origin name of the SKU. Retrieve it from the Country GET API and use the name value returned in the response.

Example:"Albania"

unitstring, non-emptyrequired

Gets or sets the measurement unit.

Example:"Piece"

unitSizestring or null

Gets or sets the unit size specification.

Example:"[Grams, Kgs, Litres, Piece, Bottle, Box, Case, Pallet, Bag, Tonnes, M3]"

unitInKgsnumber, (double)required

Gets or sets the weight of the unit in kilograms.

Example:1.25

descriptionstring or null

Gets or sets the SKU description.

Example:"Business laptop with extended warranty."

hsncodeIdstring or null, (uuid)

HSN code identifier. Retrieve it from the HSN Commodity GET API and use the ID value returned in the response.

Example:"2fa85f64-5717-4562-b3fc-2c963f66eeee"

hsnCodestring or null

Gets or sets the HSN code.

Example:"1001.91"

hsnNamestring or null

Gets or sets the HSN name.

Example:"Cereals; wheat and meslin, other than durum wheat, seed"

eudrCommodityboolean or null

Gets or sets whether the SKU belongs to an EUDR commodity.

Example:true

eudrCommodityGroupstring or null

Gets or sets the EUDR commodity group.

Example:"Wood Products"

classificationStandardIdinteger or null, (int32)

Classification standard identifier. Retrieve it from the ClassificationStandard GET API and use the ID value returned in the response.

Example:1

classificationStandardNamestring or null

Gets or sets the classification standard name.

Example:"1"

mainClassificationstring or null

Gets or sets the main classification.

Example:"[GPC,UNSPC,Custom]"

subClassificationTypeIdinteger or null, (int32)

Sub-classification type identifier. Retrieve it from the SubClassificationType GET API and use the ID value returned in the response.

Example:5

subClassificationTypeNamestring or null

Gets or sets the sub-classification type name.

Example:"[Family,Class,Brick,AttributeCode,AttributeValue,Family,Class,Commodity]"

subClassificationstring or null

Gets or sets the sub-classification.

Example:"Metal Components"

circularityTypeDurableboolean or null

Gets or sets whether the product is durable.

Example:true

circularityTypeReusableboolean or null

Gets or sets whether the product is reusable.

Example:true

circularityTypeRepairableboolean or null

Gets or sets whether the product is repairable.

Example:false

circularityTypeDisassemblableboolean or null

Gets or sets whether the product is disassemblable.

Example:true

circularityTypeRemanufacturableboolean or null

Gets or sets whether the product is remanufacturable.

Example:false

circularityTypeRefurbishableboolean or null

Gets or sets whether the product is refurbishable.

Example:true

circularityTypeRecycleableboolean or null

Gets or sets whether the product is recyclable.

Example:true

recycledContentRatenumber or null, (double)

Gets or sets the recycled content rate percentage.

Example:25.5

recyclabilityRatenumber or null, (double)

Gets or sets the recyclability rate percentage.

Example:80

soCboolean or null

Gets or sets whether the SKU contains Substances of Concern (SoC).

Example:false

svhcboolean or null

Gets or sets whether the SKU contains SVHC substances.

Example:false

scipcasstring or null

Gets or sets the SCIP CAS reference.

Example:"CAS123456"

unitOfSoCsvhcinteger or null, (int32)

Gets or sets the unit of SoC/SVHC identifier.

Example:2

unitOfSoCsvhcNamestring or null

Gets or sets the unit of SoC/SVHC name.

Example:"[CC,Grams,Tonnes,Kgs,Liters,M3]"

valueOfSoCsvhcnumber or null, (double)

Gets or sets the value of SoC/SVHC.

Example:0.5

rateOfSoCsvhcnumber or null, (double)

Gets or sets the rate of SoC/SVHC.

Example:1.2

customAttributesobject or null

Gets or sets the custom attributes associated with the SKU.

Example:

{
  "Color": "Black",
  "Warranty": "2 Years"
}

curl -i -X PUT \
  https://developer.sustainabilitymaster.ai/_mock/openapi/api/EnterpriseTables/StockKeepingUnit \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "skuid": "SKU001",
    "productId": "9fa85f64-5717-4562-b3fc-2c963f66abcd",
    "productName": "Laptop Model X",
    "companyId": 101,
    "companyName": "ABC Corporation",
    "businessUnitId": 101,
    "businessUnitName": "Consumer Electronics",
    "name": "Laptop Model X - 16GB",
    "countryOfOriginId": 110,
    "countryOfOriginName": "Albania",
    "unit": "Piece",
    "unitSize": "[Grams, Kgs, Litres, Piece, Bottle, Box, Case, Pallet, Bag, Tonnes, M3]",
    "unitInKgs": 1.25,
    "description": "Business laptop with extended warranty.",
    "hsncodeId": "2fa85f64-5717-4562-b3fc-2c963f66eeee",
    "hsnCode": "1001.91",
    "hsnName": "Cereals; wheat and meslin, other than durum wheat, seed",
    "eudrCommodity": true,
    "eudrCommodityGroup": "Wood Products",
    "classificationStandardId": 1,
    "classificationStandardName": "1",
    "mainClassification": "[GPC,UNSPC,Custom]",
    "subClassificationTypeId": 5,
    "subClassificationTypeName": "[Family,Class,Brick,AttributeCode,AttributeValue,Family,Class,Commodity]",
    "subClassification": "Metal Components",
    "circularityTypeDurable": true,
    "circularityTypeReusable": true,
    "circularityTypeRepairable": false,
    "circularityTypeDisassemblable": true,
    "circularityTypeRemanufacturable": false,
    "circularityTypeRefurbishable": true,
    "circularityTypeRecycleable": true,
    "recycledContentRate": 25.5,
    "recyclabilityRate": 80,
    "soC": false,
    "svhc": false,
    "scipcas": "CAS123456",
    "unitOfSoCsvhc": 2,
    "unitOfSoCsvhcName": "[CC,Grams,Tonnes,Kgs,Liters,M3]",
    "valueOfSoCsvhc": 0.5,
    "rateOfSoCsvhc": 1.2,
    "customAttributes": {
      "Color": "Black",
      "Warranty": "2 Years"
    }
  }'

Responses

Successfully added the StockKeepingUnit record