Skip to main content

BomUpdateRequest

namestringrequired

Name of the BOM

Possible values: <= 255 characters

descriptionstring

Description of the BOM

Possible values: <= 5000 characters

poNumberstring

PO Number (custom ID) of the PO that BOM is attached to (if available)

Possible values: <= 255 characters

attachments object[]

List of attachments to associate with the BOM

  • Array [
    • fileIduuidrequired

    UUID of the file in the file management system

  • ]
    • contributions object[]

    List of contributions to associate with the BOM

  • Array [
    • rolestringrequired

    The role of the organization in the BOM

    Possible values: [bom_viewer, bom_editor]

    orgCustomIdstringrequired

    Local Org ID of the org

  • ]
    • activebooleanrequired

    Status of the BOM (required for updates)

    componentsarray[]nullable

    Components of the BOM

    Default value: []
    BomUpdateRequest
    {
      "name": "string",
      "description": "string",
      "poNumber": "string",
      "attachments": [
        {
          "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        }
      ],
      "contributions": [
        {
          "role": "bom_viewer",
          "orgCustomId": "string"
        }
      ],
      "active": true,
      "components": [
        [
          {
            "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"
              }
            ]
          }
        ]
      ]
    }