Add a new Item Record

Request

Adds a new Item record to the system based on the provided Item details.

Security

Bearer

Query

centerIdstring, (uuid)

Bodyapplication/jsonrequired

The Item payload

Array [

idinteger, (int32)

Unique identifier for the record.

Example:1001

guidstring, (uuid)

Globally unique identifier for the record.

Example:"6fa85f64-5717-4562-b3fc-2c963f66aaaa"

isNewPurchasedGoodsboolean

Indicates whether this is newly purchased goods.

Example:true

itemIDstring, non-emptyrequired

Identifier of the purchased-goods item.

Example:"ITEM001"

itemNamestring or null

Name of the purchased-goods item.

Example:"Aluminium Sheet"

countryOfOriginIdinteger or null, (int32)

Country of origin identifier of the purchased goods. 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 -- You can retrieve it from Country GET API name field

Example:"Albania"

companyIdinteger, (int32)required

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

Example:10

companyNamestring or null

Name of the company associated with the record.

Example:"ABC Manufacturing Pvt Ltd"

businessUnitIdinteger or null, (int32)

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

Example:2

businessUnitNamestring or null

Business unit name associated with businessUnitId

Example:"Metals Division"

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

Classification standard name.

Example:"[GPC,UNSPSC,Custom]"

mainClassificationstring or null

Main classification assigned to the purchased goods.

Example:"60000000-Textual/Printed/Reference Materials"

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:3

subClassificationTypeNamestring or null

Sub-classification type name.

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

subClassificationstring or null

Subclassification assigned to the purchased goods.

Example:"60010000-Textual/Printed/Reference Materials"

subStageIdinteger or null, (int32)

Sub-stage identifier.

Example:4

subStageNamestring or null

Sub-stage name.

Example:"[Manufacturing,Packaging]"

inflowGroupIdinteger or null, (int32)

Inflow group identifier.

Example:5

inflowGroupNamestring or null

Inflow group name.

Example:"[Intermediate product,Raw material]"

inflowClassIdinteger or null, (int32)

Inflow class identifier.

Example:7

inflowClassNamestring or null

Inflow class name.

Example:"[Virgin,Secondary]"

inflowTypeIdinteger or null, (int32)

Identifier of the inflow type.

Example:9

inflowTypeNamestring or null

Name of the inflow type.

Example:"Primary Material"

inflowSubTypeIdinteger or null, (int32)

Identifier of the inflow subtype.

Example:11

inflowSubTypeNamestring or null

Name of the inflow subtype.

Example:"Sheet Metal"

inflowSubSubTypeIdinteger or null, (int32)

Inflow sub-sub-type identifier.

Example:13

inflowSubSubTypeNamestring or null

Inflow sub-sub-type name.

Example:"Aluminium Sheets"

materialSourcingIdinteger or null, (int32)

Material sourcing identifier.

Example:2

materialSourcingNamestring or null

Material sourcing name.

Example:"[Sustainably Sourced, Traditionally Sourced]"

renewabilityIdinteger or null, (int32)

Renewability identifier.

Example:1

renewabilityNamestring or null

Renewability name.

Example:"[Non-Renewable,Renewable]"

recyclabilityRatenumber or null, (double)

Rate indicating the recyclability of the packaging item or material.

Example:85.5

recyclableContentRatenumber or null, (double)

Recyclable content rate percentage.

Example:40

svhcboolean or null

Information identifying substances of very high concern (SVHC).

Example:false

soCboolean or null

Substances of concern (SoC) information for the item.

Example:false

scipcasstring or null

SCIP/CAS identifier or related substance information for the packaging item.

Example:"CAS987654"

unitOfSoCIdinteger or null, (int32)

Unit identifier for SoC measurement.

Example:2

unitOfSoCNamestring or null

Unit name for SoC measurement.

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

valueOfSoCnumber or null, (double)

Value of SoC.

Example:0.5

rateOfSoCnumber or null, (double)

Rate of SoC.

Example:1.2

purchasingUnitIdinteger, (int32)required

Purchasing unit identifier. Required field.

Example:1

purchasingUnitNamestring or null

Purchasing unit name.

Example:"[Cases,Pieces,Liters]"

purchasingValuenumber, (double)required

Purchasing value recorded for the purchased goods.

Example:250.75

purchasingUnitInKgsnumber, (double)required

Purchasing quantity expressed in kilograms.

Example:1.25

hsnCodeIdstring or null, (uuid)

Identifier of the HSN code.

Example:"8fa85f64-5717-4562-b3fc-2c963f66cccc"

hsnCodestring or null

HSN code associated with the purchased goods.

Example:"7208"

hsnNamestring or null

Description or name of the HSN code.

Example:"Flat-Rolled Iron Products"

eudrCommodityboolean or null

EUDR commodity associated with the purchased goods.

Example:true

eudrCommodityGroupstring or null

EUDR commodity group.

Example:"Wood Products"

customAttributesobject or null

Additional custom attributes associated with the record.

Example:

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

]

curl -i -X POST \
  'https://developer.sustainabilitymaster.ai/_mock/openapi/api/EnterpriseTables/Item?centerId=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "id": 1001,
      "guid": "6fa85f64-5717-4562-b3fc-2c963f66aaaa",
      "isNewPurchasedGoods": true,
      "itemID": "ITEM001",
      "itemName": "Aluminium Sheet",
      "countryOfOriginId": 110,
      "countryOfOriginName": "Albania",
      "companyId": 10,
      "companyName": "ABC Manufacturing Pvt Ltd",
      "businessUnitId": 2,
      "businessUnitName": "Metals Division",
      "classificationStandardId": 1,
      "classificationStandardName": "[GPC,UNSPSC,Custom]",
      "mainClassification": "60000000-Textual/Printed/Reference Materials",
      "subClassificationTypeId": 3,
      "subClassificationTypeName": "[Family,Class,Brick,AttributeCode,AttributeValue,Family,Class,Commodity]",
      "subClassification": "60010000-Textual/Printed/Reference Materials",
      "subStageId": 4,
      "subStageName": "[Manufacturing,Packaging]",
      "inflowGroupId": 5,
      "inflowGroupName": "[Intermediate product,Raw material]",
      "inflowClassId": 7,
      "inflowClassName": "[Virgin,Secondary]",
      "inflowTypeId": 9,
      "inflowTypeName": "Primary Material",
      "inflowSubTypeId": 11,
      "inflowSubTypeName": "Sheet Metal",
      "inflowSubSubTypeId": 13,
      "inflowSubSubTypeName": "Aluminium Sheets",
      "materialSourcingId": 2,
      "materialSourcingName": "[Sustainably Sourced, Traditionally Sourced]",
      "renewabilityId": 1,
      "renewabilityName": "[Non-Renewable,Renewable]",
      "recyclabilityRate": 85.5,
      "recyclableContentRate": 40,
      "svhc": false,
      "soC": false,
      "scipcas": "CAS987654",
      "unitOfSoCId": 2,
      "unitOfSoCName": "[CC,Grams,Tonnes,Kgs,Liters,M3]",
      "valueOfSoC": 0.5,
      "rateOfSoC": 1.2,
      "purchasingUnitId": 1,
      "purchasingUnitName": "[Cases,Pieces,Liters]",
      "purchasingValue": 250.75,
      "purchasingUnitInKgs": 1.25,
      "hsnCodeId": "8fa85f64-5717-4562-b3fc-2c963f66cccc",
      "hsnCode": "7208",
      "hsnName": "Flat-Rolled Iron Products",
      "eudrCommodity": true,
      "eudrCommodityGroup": "Wood Products",
      "customAttributes": {
        "Color": "Black",
        "Warranty": "2 Years"
      }
    }
  ]'

Responses

Successfully added the Item record