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

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
/v1/boms/{bom_id}/lines/
Boms

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Path Params
bom_id
string 
required
Body Params application/json
part
string 
Part
required
>= 1 characters<= 12 characters
approved_alternative_parts
array[string]
optional
quantity
integer 
Quantity
optional
Default:
0
do_not_place
boolean 
Do not place
optional
Default:
false
ignore
boolean 
Ignore
optional
Default:
false
reference_designators
array[string]
optional
reference_designators_string
string 
Reference designators string
optional
>= 1 characters
notes
string  | null 
Notes
optional
>= 1 characters
metadata
object 
Metadata
optional
Default:
{}
Example
{
  "part": "string",
  "approved_alternative_parts": [],
  "quantity": 0,
  "do_not_place": false,
  "ignore": false,
  "reference_designators": [
    "string"
  ],
  "reference_designators_string": "string",
  "notes": "string",
  "metadata": {}
}

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 POST '/v1/boms//lines/' \
--header 'Content-Type: application/json' \
--header 'Authorization;' \
--data-raw ''

Responses

🟢200Success
application/json
Body
id
string <uuid>
Id
read-onlyoptional
bom_id
string 
Bom id
read-onlyoptional
part
object (PartCore) 
required
id
string 
Id
required
>= 1 characters<= 12 characters
custom_id
string  | null 
Custom id
optional
<= 255 characters
mpn
string  | null 
Mpn
optional
<= 255 characters
alt_mpns
array[string]
optional
classification
string  | null 
Classification
optional
<= 255 characters
description
string  | null 
Description
optional
lifecycle_status
enum<string>  | enum<null> 
Lifecycle status
optional
Allowed values:
NewProductionEOLNRFNDObsolete
hero_image
string  | null 
Hero image
optional
<= 255 characters
mfg
string  | null 
Mfg
optional
<= 255 characters
package
string  | null 
Package
optional
<= 255 characters
terminations
integer  | null 
Terminations
optional
>= -2147483648<= 2147483647
termination_type
string  | null 
Termination type
optional
<= 255 characters
deprecated_by
string  | null 
Deprecated by
optional
is_customized_info
string 
Is customized info
read-onlyoptional
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
Example
{
  "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": {}
}
Modified at 2023-09-05 19:45:28
Previous
Gets Bom Lines on a Bom.
Next
Gets a BomLine
Built with