Skip to main content

Bill of Materials (BOM)

A bill of materials (BOM) is a list of the raw materials, components, parts, and quantities you need to manufacture a product. With the BOM API, you can create, read, update, and delete BOMs for a purchase order (PO), style, item, or material, and you can link each component to your existing Material Library and Supplier Management records instead of typing descriptive text. This gives you accurate, traceable BOM data, so you get the same material and supplier links whether the BOM was created in the UI or through your own integration.

Precondition​

  • Generate an API key for your organization and use it to authenticate your API requests.
  • Before you link BOM components to materials or suppliers, you need your Material Management (Material Library) and Supplier Management data already set up in Inspectorio, either through the UI or through your own integrations. The BOM API resolves references to these records, but it does not create Materials, Suppliers, or Facilities on your behalf. For more information, contact your Inspectorio account manager.

Create a new BOM​

The Create a new BOM endpoint lets you add a new BOM to a product, item, or material. You can enter each component manually, or you can link it to a Material Library or Supplier Management record, so your BOM data stays connected to the rest of your catalog.

To create a new BOM, use the POST Create a new BOM API endpoint.

List all BOMs for an entity​

The List all BOMs for an entity endpoint returns every BOM attached to a given entity. Use this endpoint when you need to see all the BOMs for a purchase order, style, item, or material, along with their link status.

To etrieve a list of BOMs for an entity, use the GET List all BOMs for an entity API endpoint.

Update an existing BOM​

The Update an existing BOM endpoint replaces an existing BOM with the components you send in your request. Use this endpoint both to change a BOM's contents and to refresh a linked BOM after the underlying material or organization profile changes.

To update an existing BOM, use the PUT Update an existing BOM API endpoint.

Get BOM details​

The Get BOM details endpoint returns the full details of a single BOM. Use this endpoint when you already know which BOM you need and want to see its current components and link status.

To retrieve the details of a BOM, use the Get BOM details API endpoint.

Delete a BOM​

The Delete a BOM endpoint removes a BOM from a purchase order, style, item, or material. Use this endpoint when a BOM is no longer needed for that entity.

To delete a BOM, use the Delete a BOM API endpoint.