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

Get Part

GET
/v1/org_parts/{org_part_id}/

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Path Params
org_part_id
string 
required
Query Params
blended
string 
optional
If given, includes parts belonging to suborgs in the lookup

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/org_parts//?blended' \
--header 'Authorization;'

Responses

🟢200Success
application/json
Body
id
string <uuid>
Id
read-onlyrequired
created_at
string <date-time>
Created at
read-onlyrequired
updated_at
string <date-time>
Updated at
read-onlyrequired
custom_id
string 
Custom id
required
<= 255 characters
org_id
string 
Org id
read-onlyrequired
cofactr_id
string 
Cofactr id
required
>= 1 characters
aec
enum<string> 
Aec
required
Allowed values:
AEC-Q001AEC-Q002AEC-Q003AEC-Q004AEC-Q005AEC-Q006AEC-Q100AEC-Q101AEC-Q102AEC-Q103AEC-Q104AEC-Q200AEC-Q unknown
classification
string 
Classification
required
<= 255 characters
description
string 
Description
required
hero_image
string 
Hero image
required
<= 255 characters
lifecycle_status
enum<string> 
Lifecycle status
required
Allowed values:
NewProductionEOLNRFNDObsolete
mfg
string 
Mfg
required
<= 255 characters
mpn
string 
Mpn
required
<= 255 characters
msl
string 
Msl
required
<= 2 characters
package
string 
Package
required
<= 255 characters
reach
enum<string> 
Reach
required
Allowed values:
REACH AffectedREACH CompliantREACH Non-CompliantREACH UnaffectedREACH Unknown
rohs
enum<string> 
Rohs
required
Allowed values:
RoHS Compliant by ExemptionRoHS CompliantRoHS Non-CompliantRoHS UnknownRoHS3 Compliant by ExemptionRoHS3 Compliant
termination_type
string 
Termination type
required
<= 255 characters
terminations
integer 
Terminations
required
>= -2147483648<= 2147483647
data_updated_at
string <date-time>
Data updated at
required
Example
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "custom_id": "string",
  "org_id": "string",
  "cofactr_id": "string",
  "aec": "AEC-Q001",
  "classification": "string",
  "description": "string",
  "hero_image": "string",
  "lifecycle_status": "New",
  "mfg": "string",
  "mpn": "string",
  "msl": "st",
  "package": "string",
  "reach": "REACH Affected",
  "rohs": "RoHS Compliant by Exemption",
  "termination_type": "string",
  "terminations": -2147483648,
  "data_updated_at": "2019-08-24T14:15:22Z"
}
Modified at 2024-08-23 05:10:57
Previous
Async Upsert Parts
Next
Get Purchase Order
Built with