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 Availabilities Async
      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

Upsert BOM Async

PUT
integrations/async_boms/
Boms

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Body Params application/json
name
string 
required
<= 255 characters
version
string  | null 
optional
<= 255 characters
Default:
null
part_number
string 
optional
<= 255 characters
Default:
null
approved
boolean 
optional
Default:
false
lines
array[object (CreateRawBomLine) {17}] 
optional
custom_id
string  | null 
Custom id
optional
>= 1 characters<= 255 characters
mpn
string  | null 
Mpn
required
>= 1 characters<= 255 characters
alternative_mpns
array[string]
optional
manufacturer_name
string  | null 
Manufacturer name
optional
>= 1 characters<= 255 characters
quantity
integer 
Quantity
optional
Default:
0
reference_designators_string
string 
Reference designators string
optional
>= 1 characters<= 255 characters
reference_designators
array[string]
optional
description
string  | null 
Description
optional
>= 1 characters<= 255 characters
link
string  | null 
Link
optional
>= 1 characters<= 255 characters
comments
string  | null 
Comments
optional
>= 1 characters<= 255 characters
do_not_place
boolean 
Do not place
optional
Default:
false
line_number
string  | null 
Line number
optional
>= 1 characters<= 255 characters
value
string  | null 
Value
optional
>= 1 characters<= 255 characters
package
string  | null 
Package
optional
>= 1 characters<= 255 characters
mount_type
string  | null 
Mount type
optional
>= 1 characters<= 255 characters
metadata
object 
Metadata
optional
Default:
{}
is_custom_part
boolean 
optional
Default:
false
metadata
object 
optional
integration_record_id
string  | null 
optional
synced_from_integration
boolean 
optional
integration_source_name
string 
optional
synced_from_integration_at
string <date-time>
optional
Example
{
  "name": "string",
  "version": "null",
  "part_number": "null",
  "approved": false,
  "lines": [
    {
      "custom_id": "string",
      "mpn": "string",
      "alternative_mpns": [],
      "manufacturer_name": "string",
      "quantity": 0,
      "reference_designators_string": "string",
      "reference_designators": [
        "string"
      ],
      "description": "string",
      "link": "string",
      "comments": "string",
      "do_not_place": false,
      "line_number": "string",
      "value": "string",
      "package": "string",
      "mount_type": "string",
      "metadata": {},
      "is_custom_part": "false"
    }
  ],
  "metadata": {},
  "integration_record_id": "string",
  "synced_from_integration": true,
  "integration_source_name": "string",
  "synced_from_integration_at": "2019-08-24T14:15:22Z"
}

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 PUT 'integrations/async_boms/' \
--header 'Content-Type: application/json' \
--header 'Authorization;' \
--data-raw '{
    "name": "string",
    "version": "null",
    "part_number": "null",
    "approved": false,
    "lines": [
        {
            "custom_id": "string",
            "mpn": "string",
            "alternative_mpns": [],
            "manufacturer_name": "string",
            "quantity": 0,
            "reference_designators_string": "string",
            "reference_designators": [
                "string"
            ],
            "description": "string",
            "link": "string",
            "comments": "string",
            "do_not_place": false,
            "line_number": "string",
            "value": "string",
            "package": "string",
            "mount_type": "string",
            "metadata": {},
            "is_custom_part": "false"
        }
    ],
    "metadata": {},
    "integration_record_id": "string",
    "synced_from_integration": true,
    "integration_source_name": "string",
    "synced_from_integration_at": "2019-08-24T14:15:22Z"
}'

Responses

🟢200Success
application/json
Body
string 
optional
Example
"string"
Modified at 2024-08-22 21:47:54
Previous
Gets a Bom
Next
Updates a Bom
Built with