Cofactr Platform API
  1. Parts
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
      POST
    • Async Upsert Parts
      PUT
    • Get Part
      GET
  • 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. Parts

Async Create Parts

POST
/integrations/async_sync_parts/
Syncs parts from an external system. Will not update existing parts.

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Body Params application/json
parts
array[object (CreateSyncPart) {16}] 
required
mpn
string 
Mpn
required
>= 1 characters<= 255 characters
alternative_mpns
array[string]
optional
manufacturer_name
string 
Manufacturer name
required
>= 1 characters<= 255 characters
custom_id
string 
Custom id
optional
>= 1 characters<= 255 characters
manufacturer_id
string 
Manufacturer id
optional
>= 1 characters<= 255 characters
classification_id
string 
Classification id
optional
>= 1 characters<= 255 characters
custom_classification_name
string 
Custom classification name
optional
>= 1 characters<= 255 characters
msl
string 
Msl
optional
>= 1 characters<= 6 characters
description
string 
Description
optional
>= 1 characters
package
string 
Package
optional
>= 1 characters<= 255 characters
terminations
integer 
Terminations
optional
termination_type
string 
Termination type
optional
>= 1 characters<= 255 characters
reach
enum<string> 
Reach
optional
Allowed values:
REACH AffectedREACH CompliantREACH Non-CompliantREACH UnaffectedREACH Unknown
rohs
enum<string> 
Rohs
optional
Allowed values:
RoHS Compliant by ExemptionRoHS CompliantRoHS Non-CompliantRoHS UnknownRoHS3 Compliant by ExemptionRoHS3 Compliant
aec
enum<string> 
Aec
optional
Allowed values:
AEC-Q001AEC-Q002AEC-Q003AEC-Q004AEC-Q005AEC-Q006AEC-Q100AEC-Q101AEC-Q102AEC-Q103AEC-Q104AEC-Q200AEC-Q unknown
is_custom_part
boolean 
optional
Example
{
  "parts": [
    {
      "mpn": "string",
      "alternative_mpns": [],
      "manufacturer_name": "string",
      "custom_id": "string",
      "manufacturer_id": "string",
      "classification_id": "string",
      "custom_classification_name": "string",
      "msl": "string",
      "description": "string",
      "package": "string",
      "terminations": 0,
      "termination_type": "string",
      "reach": "REACH Affected",
      "rohs": "RoHS Compliant by Exemption",
      "aec": "AEC-Q001",
      "is_custom_part": true
    }
  ]
}

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 '/integrations/async_sync_parts/' \
--header 'Content-Type: application/json' \
--header 'Authorization;' \
--data-raw '{
    "parts": [
        {
            "mpn": "string",
            "alternative_mpns": [],
            "manufacturer_name": "string",
            "custom_id": "string",
            "manufacturer_id": "string",
            "classification_id": "string",
            "custom_classification_name": "string",
            "msl": "string",
            "description": "string",
            "package": "string",
            "terminations": 0,
            "termination_type": "string",
            "reach": "REACH Affected",
            "rohs": "RoHS Compliant by Exemption",
            "aec": "AEC-Q001",
            "is_custom_part": true
        }
    ]
}'

Responses

🟢200Success
application/json
Body
string 
optional
Example
Queueing {x} parts for creation syncing
Modified at 2024-08-23 03:25:56
Previous
Get Suppliers
Next
Async Upsert Parts
Built with