Skip to content

Add a Packaging BOM

Request

Creates a direct-composition Packaging BOM row in the optional center scope. A valid authorization token is required.

Security
Bearer
Query
centerIdstring, (uuid)
Body
packagingUnitIdinteger, (int32)

Identifier of the packaging unit associated with this record.

packagingItemIdstring or null

Identifier of the packaging item associated with this record.

packagingItemGtinstring or null

Global Trade Item Number (GTIN) used to uniquely identify the packaging item or component.

packagingItemNamestring or null

Business-facing name of the packaging item or component, such as cap, label, carton or film.

packagingItemDescriptionstring or null

Additional description providing further details about the packaging item or component, such as its purpose, characteristics or distinguishing features.

packagingItemWeightUnitstring or null

Unit of measure used for the packaging item weight.

packagingItemWeightValuenumber, (double)

Weight value of the individual packaging item or component.

packagingMaterialTypeIdinteger or null, (int32)

Unique identifier assigned to Packaging Material Type

packagingMaterialSubTypeIdinteger or null, (int32)

Unique identifier assigned to Packaging Material Sub Type

itemClassstring or null

Class or origin type of the material, for example virgin or secondary material.

recycledContentRatenumber or null, (double)

Percentage or rate of recycled content for the packaging item.

recyclabilityRatenumber or null, (double)

Rate indicating the recyclability of the packaging item or material.

recyclingIdentificationCodestring or null

Material identification code printed on or assigned to the component, where available.

directContactFlagboolean or null

Indicates whether the component is in direct contact with the product.

packagingWasteClassIdinteger or null, (int32)

Unique identifier assigned to Packaging Waste Class

useCyclestring or null

Indicates whether the component is intended for single use, reuse or another defined use cycle.

usedAndDisposedWithProductFlagboolean or null

Indicates whether the component is normally used and disposed of together with the product.

compostableboolean or null

Indicates whether the component is classified as compostable based on available material or supplier data.

colorInApplicationIdinteger or null, (int32)

Unique identifier assigned to Color In Application

coverageAreaPercentagenumber or null, (double)

Approximate percentage of the component surface covered by print, coating, label or decoration.

separateabilityTypeIdinteger or null, (int32)

Unique identifier assigned to Separateability Type

washabilityboolean or null

Auto-derived from Seperateability Type. Indicates whether print, ink, adhesive or coating can be removed through a washing process, where relevant.

printInkTypeIdinteger or null, (int32)

Unique identifier assigned to Print / Ink Type

packagingElementIdinteger or null, (int32)

Unique identifier assigned to Packaging Element

containsPfasboolean or null

Indicates whether this component contains PFAS substances.

pfasTypeIdinteger or null, (int32)

Unique identifier assigned to PFAS Type

pfasMassnumber or null, (double)

Quantity of PFAS substances present in the component, where known.

pfasMassUnitstring or null

Unit used to express the PFAS quantity.

containsHeavyMetalboolean or null

Indicates whether this component contains heavy metals.

heavyMetalTypeIdinteger or null, (int32)

Unique identifier assigned to Heavy Metal Type

heavyMetalMassnumber or null, (double)

Quantity of heavy metals present in the component, where known.

heavyMetalMassUnitstring or null

Unit used to express the heavy metal quantity.

containsSoCboolean or null

Indicates whether the component contains a substance that requires internal tracking.

containsSvhcboolean or null

Indicates whether the component contains a substance identified as very high concern in supplier or material data.

scipcasstring or null

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

soCsvhcMassUnitstring or null

Unit used to express the tracked substance quantity or concentration.

soCsvhcMassnumber or null, (double)

Quantity or concentration value of the tracked substance.

hazardousWasteClassificationboolean or null

Indicates whether the component is classified as hazardous waste in relevant internal or supplier data.

biodegradabilityPercentagenumber or null, (double)

Estimated percentage of the component that is biodegradable, where applicable.

allergenFreeboolean or null

Indicates whether the component is confirmed as allergen-free in supplier or material data.

visibilitystring or null

Indicates whether the component is transparent, translucent, opaque or otherwise visible in use.

curl -i -X POST \
  'https://developer.sustainabilitymaster.ai/_mock/openapi/api/EnterpriseTables/PackagingBOM?centerId=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "packagingUnitId": 0,
    "packagingItemId": "string",
    "packagingItemGtin": "string",
    "packagingItemName": "string",
    "packagingItemDescription": "string",
    "packagingItemWeightUnit": "string",
    "packagingItemWeightValue": 0.1,
    "packagingMaterialTypeId": 0,
    "packagingMaterialSubTypeId": 0,
    "itemClass": "string",
    "recycledContentRate": 0.1,
    "recyclabilityRate": 0.1,
    "recyclingIdentificationCode": "string",
    "directContactFlag": true,
    "packagingWasteClassId": 0,
    "useCycle": "string",
    "usedAndDisposedWithProductFlag": true,
    "compostable": true,
    "colorInApplicationId": 0,
    "coverageAreaPercentage": 0.1,
    "separateabilityTypeId": 0,
    "washability": true,
    "printInkTypeId": 0,
    "packagingElementId": 0,
    "containsPfas": true,
    "pfasTypeId": 0,
    "pfasMass": 0.1,
    "pfasMassUnit": "string",
    "containsHeavyMetal": true,
    "heavyMetalTypeId": 0,
    "heavyMetalMass": 0.1,
    "heavyMetalMassUnit": "string",
    "containsSoC": true,
    "containsSvhc": true,
    "scipcas": "string",
    "soCsvhcMassUnit": "string",
    "soCsvhcMass": 0.1,
    "hazardousWasteClassification": true,
    "biodegradabilityPercentage": 0.1,
    "allergenFree": true,
    "visibility": "string"
  }'

Responses

Successfully created the Packaging BOM