Skip to main content

BomItem

BOM items are the components of a product.

type BomItem {
  componentReference: BomComponentReference @deprecated
  designators: [String!]!
  elements: [BomItemElement!]!
  extraQuantity: Int!
  hiddenElements: [BomItemElement!]!
  issues: [BomIssue!]!
  itemId: String!
  primaryElement: BomItemElement
  quantity: Int!
  totalQuantity: Int!
}

Fields

`BomItem.componentReference` ● `BomComponentReference` deprecated object

DEPRECATED

Use 'primaryElement.componentReference' instead.

A reference to a component linked to the primary element.

`BomItem.designators` ● `[String!]!` non-null scalar

A list of designators that specify the placements of the item within the schematic.

`BomItem.elements` ● `[BomItemElement!]!` non-null interface

All elements that could be used for this item (alternates and substitutes).

`BomItem.extraQuantity` ● `Int!` non-null scalar

Extra quantity of the item to order. This is added to the product of 'Quantity' and 'BOM Production Quantity' to calculate the 'Total Quantity'.

`BomItem.hiddenElements` ● `[BomItemElement!]!` non-null interface

Elements that were hidden from the 'elements' list.

`BomItem.issues` ● `[BomIssue!]!` non-null object

Issues associated with the item.

`BomItem.itemId` ● `String!` non-null scalar

ID of the item. Items preserve their ID across releases of the BOM.

`BomItem.primaryElement` ● `BomItemElement` interface

The primary element chosen for this item.

`BomItem.quantity` ● `Int!` non-null scalar

The quantity of the item required to produce one unit.

`BomItem.totalQuantity` ● `Int!` non-null scalar

The total quantity of the item to order, calculated as "(Quantity * BOM Production Quantity) + Extra Quantity".