Skip to main content

BomComponentCreateObject

customIdstringnullable

Custom ID of the component

supplierComponentIdstringnullable

Supplier component ID

namestringrequired

Name of the component

descriptionstringnullable

Description of the component

productTypestringrequired

Product type of the component

Possible values: [product, item, material]

groupstringnullable

Group of the component

unitYieldnumbernullable

Unit yield of the component

yieldUomstringnullable

Yield unit of the component

unitWeightnumbernullable

Unit weight of the component

weightUomstringnullable

Weight unit of the component

unitCostnumbernullable

Unit cost of the component

costCurrencystringnullable

Cost currency of the component

totalYieldnumbernullable

Total yield of the component

totalWeightnumbernullable

Total weight of the component

supplier objectnullable
namestringrequired

Name of the supplier

customIdstringnullable

Custom ID of the supplier

addressstringnullable

Address of the supplier

citystringnullable

City of the supplier

stateProvincestringnullable

State/Province of the supplier

postalZipCodestringnullable

Postal/Zip code of the supplier

countrystringnullable

Country of the supplier

phonestringnullable

Phone of the supplier

contactNamestringnullable

Contact name of the supplier

contactEmailstringnullable

Contact email of the supplier

contactPhonestringnullable

Contact phone of the supplier

facilities object[]nullable

Facilities of the component

  • Array [
  • namestringrequired

    Name of the facility

    capabilitiesstring[]nullable

    Capabilities of the facility

    customIdstringnullable

    Custom ID of the facility

    addressstringnullable

    Address of the facility

    citystringnullable

    City of the facility

    stateProvincestringnullable

    State/Province of the facility

    postalZipCodestringnullable

    Postal/Zip code of the facility

    countrystringnullable

    Country of the facility

    phonestringnullable

    Phone of the facility

    contactNamestringnullable

    Contact name of the facility

    contactEmailstringnullable

    Contact email of the facility

    contactPhonestringnullable

    Contact phone of the facility

  • ]
  • esgs object[]nullable

    ESGs of the component

  • Array [
  • groupstringnullable

    Group of the ESG

    standardstringrequired

    Standard of the ESG

    unitAmountnumbernullable

    Unit amount of the ESG

    amountUomstringnullable

    amount uom of the ESG

  • ]
  • bom objectnullable
    componentsundefined[]
    BomComponentCreateObject
    {
    "customId": "string",
    "supplierComponentId": "string",
    "name": "string",
    "description": "string",
    "productType": "product",
    "group": "string",
    "unitYield": 0,
    "yieldUom": "string",
    "unitWeight": 0,
    "weightUom": "string",
    "unitCost": 0,
    "costCurrency": "string",
    "totalYield": 0,
    "totalWeight": 0,
    "supplier": {
    "name": "string",
    "customId": "string",
    "address": "string",
    "city": "string",
    "stateProvince": "string",
    "postalZipCode": "string",
    "country": "string",
    "phone": "string",
    "contactName": "string",
    "contactEmail": "string",
    "contactPhone": "string"
    },
    "facilities": [
    {
    "name": "string",
    "capabilities": [
    "string"
    ],
    "customId": "string",
    "address": "string",
    "city": "string",
    "stateProvince": "string",
    "postalZipCode": "string",
    "country": "string",
    "phone": "string",
    "contactName": "string",
    "contactEmail": "string",
    "contactPhone": "string"
    }
    ],
    "esgs": [
    {
    "group": "string",
    "standard": "string",
    "unitAmount": 0,
    "amountUom": "string"
    }
    ],
    "bom": {
    "components": [
    null
    ]
    }
    }