Skip to main content
View as Markdown

BomItem

BOM items are the components of a product.

Common Data Model​

  • BOM Item — One line of a BOM: its designators and quantity, the primary manufacturer part used for it (identified by manufacturer and manufacturer part number), and any alternate parts recorded for that line. A line can be linked to a Workspace component that lists its part among its Part Choices, and BOM checks report issues against individual lines.

Member Of​

BomItemsConnection object ● BomItemsEdge object

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

Fields​

designators ● [String!]! non-null scalar​

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

elements ● [BomItemElement!]! non-null interface​

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

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'.

hiddenElements ● [BomItemElement!]! non-null interface​

Elements that were hidden from the 'elements' list.

issues ● [BomIssue!]! non-null object​

Issues associated with the item.

itemId ● String! non-null scalar​

Identifier of the item. Items preserve their identifier across releases of the BOM.

primaryElement ● BomItemElement interface​

The primary element chosen for this item.

quantity ● Int! non-null scalar​

The quantity of the item required to produce one unit.

totalQuantity ● Int! non-null scalar​

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

Show deprecated

componentReference ● BomComponentReference deprecated object​

DEPRECATED

Use 'primaryElement.componentReference' instead.

A reference to a component linked to the primary element.