Cofactr Platform API
  1. BOMs
Cofactr Platform API
  • BOMs
    • Gets Boms that user has read access to
      GET
    • Creates a Bom using Cofactr Data
      POST
    • Creates a Bom using raw bomline data and performs searches to convert into Cofactr Data
      POST
    • Gets a Bom
      GET
    • Upsert BOM Async
      PUT
    • Updates a Bom
      PATCH
    • Deletes a Bom if still unapproved. Archives a bom if approved.
      DELETE
    • Approves an unapproved Bom.
      POST
    • Gets Bom Lines on a Bom.
      GET
    • Creates a new bomline on a Bom using Cofactr data. If a bomline with the provided part exists it will sum the quants instead of duplicating lines.
      POST
    • Gets a BomLine
      GET
    • Updates a BomLine
      PATCH
    • Removes a Bomline from a Bom.
      DELETE
    • Attempts to create a new Bomline using raw data and performs searches to convert into Cofactr Data. If a Bomline with the same part and refdes exists it will sum the quants instead of duplicating lines.
      POST
  • Programs
    • Gets Programs
      GET
    • Creates a Program
      POST
    • Gets a Program
      GET
    • Updates a Program
      PATCH
    • Deletes a Program
      DELETE
    • Gets Program Availabilities
      GET
    • Gets Program Reference Pricing
      GET
    • Get Programs Lines
      GET
    • Get Programs Line
      GET
    • Update Programs Line
      PATCH
    • Delete Programs Line
      DELETE
    • Create Programs Lines
      POST
    • Get Program Part Overrides
      GET
    • Create Program Part Overrides
      POST
    • Get Program Part Override
      GET
    • Update Program Part Override
      PATCH
    • Delete Program Part Override
      DELETE
  • Account
    • Sub Org
      • List Sub Orgs
      • Get Sub Org
      • Update Sub Org
      • Create Sub Org
    • Get Org
    • Get Users
    • Get User
  • Reporting
    • Customer SQL Query
  • Email
    • Mark Outbound Email as Sent
    • Create Outbound Email
    • Get Outbound Email
  • Auth
    • Update API Key
  • Async Jobs
    • Get Async Job Status
  • Stock Documents
    • List StockDocuments
    • Get StockDocument
    • Download StockDocument
    • Create StockDocument
  • Suppliers
    • Create Supplier
    • Update Supplier
    • Get Supplier
    • Get Suppliers
  • Parts
    • Async Create Parts
    • Async Upsert Parts
    • Get Part
  • Purchases
    • Get Purchase Order
    • Create Purchase Order
    • Update Purchase Order
    • Delete Purchase Order
    • Get Purchase Lines
    • Get Purchase Line
    • Create Purchase Line
    • Update Many Purchase Lines
    • Delete Purchase Line
    • Get NoPart Purchase Lines
    • Create NoPart Purchase Line
    • Update Many NoPart Purchase Lines
    • Delete NoPart Purchase Line
    • Create Purchase Event
    • Update Supplier Bill
    • Update Supplier Bill Line
    • Create Supplier Bill
    • Create Supplier Bill Line
  • Teams
    • Get Teams
    • Create Team
    • Get Team
    • Update Team
    • Delete Team
    • Archive Team
    • Unarchive Team
    • Get Team Types
    • Create Team Type
    • Get Team Type
    • Update Team Type
    • Delete Team Type
  • Custom Properties
    • Get Custom Properties
    • Create Custom Property
    • Update Custom Property
    • Get Custom Property
  • Stock Lots
    • Updates a StockLot
    • Upsert Part Stock
  • Tags
    • Get tags
    • Create tag
    • Get tag
    • Update tag
  • Rfqs
    • Create Rfq
    • Update Rfq
  • RfqLines
    • Create RfqLine
    • Update RfqLine
  • SupplierQuote
    • Create Supplier Quote
    • Update Supplier Quote
  • SupplierQuoteLines
    • Create Supplier Quote Line
    • Update Supplier Quote Line
  1. BOMs

Gets Bom Lines on a Bom.

GET
/v1/boms/{bom_id}/lines/
Boms

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Path Params
bom_id
string 
required

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/boms//lines/' \
--header 'Authorization;'

Responses

🟢200Success
application/json
Body
array of:
id
string <uuid>
Id
read-onlyoptional
name
string  | null 
Name
optional
<= 255 characters
version
string  | null 
Version
optional
<= 255 characters
part_number
string  | null 
Part number
required
>= 1 characters<= 255 characters
approved
string 
Approved
read-onlyoptional
metadata
object  | null 
Metadata
required
org_id
string 
Org id
read-onlyoptional
data_source
string  | null 
Data source
optional
Where this record originated from. Null indicates normal Flagship operation, otherwise refers to input integration source.
<= 255 characters
lines
array[object (BomLine) {12}] 
read-onlyoptional
id
string <uuid>
Id
read-onlyoptional
bom_id
string 
Bom id
read-onlyoptional
part
object (PartCore) 
required
approved_alternative_parts
string 
Approved alternative parts
read-onlyoptional
quantity
integer 
Quantity
required
do_not_place
boolean 
Do not place
required
ignore
boolean 
Ignore
optional
reference_designators
array[string | null]
required
reference_designators_string
string 
Reference designators string
read-onlyoptional
notes
string  | null 
Notes
required
>= 1 characters
metadata
object  | null 
Metadata
required
raw
object  | null 
Raw
optional
raw_lines
array[object (RawBomLine) {14}] 
read-onlyoptional
mpn
string 
Mpn
read-onlyoptional
alternative_mpns
string 
Alternative mpns
read-onlyoptional
manufacturer_name
string 
Manufacturer name
read-onlyoptional
quantity
string 
Quantity
read-onlyoptional
reference_designators_string
string 
Reference designators string
read-onlyoptional
reference_designators
string 
Reference designators
read-onlyoptional
description
string 
Description
read-onlyoptional
link
string 
Link
read-onlyoptional
comments
string 
Comments
read-onlyoptional
do_not_place
string 
Do not place
read-onlyoptional
line_number
string 
Line number
read-onlyoptional
value
string 
Value
read-onlyoptional
package
string 
Package
read-onlyoptional
mount_type
string 
Mount type
read-onlyoptional
synced_from_integration
boolean 
optional
Default:
false
synced_from_integration_at
string <date-time> | null 
optional
integration_source_name
string  | null 
optional
integration_record_id
string  | null 
optional
Example
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "version": "string",
    "part_number": "string",
    "approved": "string",
    "metadata": {},
    "org_id": "string",
    "data_source": "string",
    "lines": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "bom_id": "string",
        "part": {
          "id": "string",
          "custom_id": "string",
          "mpn": "string",
          "alt_mpns": [
            "string"
          ],
          "classification": "string",
          "description": "string",
          "lifecycle_status": "New",
          "hero_image": "string",
          "mfg": "string",
          "package": "string",
          "terminations": -2147483648,
          "termination_type": "string",
          "deprecated_by": "string",
          "is_customized_info": "string"
        },
        "approved_alternative_parts": "string",
        "quantity": 0,
        "do_not_place": true,
        "ignore": true,
        "reference_designators": [
          "string"
        ],
        "reference_designators_string": "string",
        "notes": "string",
        "metadata": {},
        "raw": {}
      }
    ],
    "raw_lines": [
      {
        "mpn": "string",
        "alternative_mpns": "string",
        "manufacturer_name": "string",
        "quantity": "string",
        "reference_designators_string": "string",
        "reference_designators": "string",
        "description": "string",
        "link": "string",
        "comments": "string",
        "do_not_place": "string",
        "line_number": "string",
        "value": "string",
        "package": "string",
        "mount_type": "string"
      }
    ],
    "synced_from_integration": false,
    "synced_from_integration_at": "2019-08-24T14:15:22Z",
    "integration_source_name": "string",
    "integration_record_id": "string"
  }
]
Modified at 2023-09-05 19:45:28
Previous
Approves an unapproved Bom.
Next
Creates a new bomline on a Bom using Cofactr data. If a bomline with the provided part exists it will sum the quants instead of duplicating lines.
Built with