Skip to main content

BomComponentIntegrationObject

customIdstring

Custom ID of the component

namestring

Name of the component

descriptionstring

Description of the component

supplierComponentIdstring

Supplier component ID

groupstring

Group of the component

unitYieldnumber

Unit yield of the component

yieldUomstring

Yield unit of the component

unitWeightnumber

Unit weight of the component

weightUomstring

Weight unit of the component

unitCostnumber

Unit cost of the component

totalYieldnumber

Total yield of the component

totalWeightnumber

Total weight of the component

costCurrencystring

Cost currency of the component

supplier object
namestring

Name of the supplier

customIdstring

Custom ID of the supplier

addressstring

Address of the supplier

citystring

City of the supplier

stateProvincestring

State/Province of the supplier

postalZipCodestring

Postal/Zip code of the supplier

countrystring

Country of the supplier

phonestring

Phone of the supplier

contactNamestring

Contact name of the supplier

contactEmailstring

Contact email of the supplier

contactPhonestring

Contact phone of the supplier

facilities object[]

Facilities of the component

  • Array [
  • namestring

    Name of the facility

    capabilitiesstring[]

    Capabilities of the facility

    customIdstring

    Custom ID of the facility

    addressstring

    Address of the facility

    citystring

    City of the facility

    stateProvincestring

    State/Province of the facility

    postalZipCodestring

    Postal/Zip code of the facility

    countrystring

    Country of the facility

    phonestring

    Phone of the facility

    contactNamestring

    Contact name of the facility

    contactEmailstring

    Contact email of the facility

    contactPhonestring

    Contact phone of the facility

  • ]
  • bom object
    customIdstring

    Custom ID of the BOM

    namestring

    Name of the BOM

    descriptionstring

    Description of the BOM

    enabledboolean

    Is the BOM active

    createdAtdate-time

    Created at date of the BOM

    productTypestring

    Product type of the BOM

    productCustomIdstring

    Custom ID of the product (item/style)

    poNumberstring

    Purchase order number of the BOM

    attachments object[]

    Attachments of the BOM

  • Array [
  • fileNamestring

    File name of the attachment

    fileUrlstring

    URL of the attachment

  • ]
  • contributions object[]

    Contributors of the BOM

  • Array [
  • rolestring

    Role of the contributor

    Possible values: [bom_editor, bom_viewer]

    orgCustomIdstringnullable

    Custom ID of the contributor org

  • ]
  • componentsundefined[]

    Components of the BOM

    BomComponentIntegrationObject
    {
    "customId": "string",
    "name": "string",
    "description": "string",
    "supplierComponentId": "string",
    "group": "string",
    "unitYield": 0,
    "yieldUom": "string",
    "unitWeight": 0,
    "weightUom": "string",
    "unitCost": 0,
    "totalYield": 0,
    "totalWeight": 0,
    "costCurrency": "string",
    "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"
    }
    ],
    "bom": {
    "customId": "string",
    "name": "string",
    "description": "string",
    "enabled": true,
    "createdAt": "2024-07-29T15:51:28.071Z",
    "productType": "string",
    "productCustomId": "string",
    "poNumber": "string",
    "attachments": [
    {
    "fileName": "string",
    "fileUrl": "string"
    }
    ],
    "contributions": [
    {
    "role": "bom_editor",
    "orgCustomId": "string"
    }
    ],
    "components": [
    null
    ]
    }
    }