Cofactr Platform API
  1. Programs
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. Programs

Creates a Program

POST
/v1/programs/
Production Runs

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Body Params application/json
name
string 
Name
required
>= 1 characters<= 255 characters
reference_number
string  | null 
Reference number
optional
>= 1 characters<= 255 characters
production_date
string <date> | null 
Production date
optional
notes
string  | null 
Notes
optional
>= 1 characters
approved
boolean 
Approved
optional
Default:
false
metadata
object 
Metadata
optional
Default:
{}
lines
array [object {2}] 
optional
bom
string <uuid>
Bom
required
quant
integer 
Quant
required
synced_from_integration
boolean 
optional
integration_source_name
string  | null 
optional
integration_record_id
string  | null 
optional
synced_from_integration_at
string <date-time>
optional
po_footer_notes
string 
optional
include_expected_stock
boolean 
optional
Default:
false
include_processing_stock
boolean 
optional
Default:
false
include_on_hand_stock
boolean 
optional
Default:
false
add_overage
boolean 
optional
Default:
true
Example
{
  "name": "string",
  "reference_number": "string",
  "production_date": "2019-08-24",
  "notes": "string",
  "approved": false,
  "metadata": {},
  "lines": [],
  "synced_from_integration": true,
  "integration_source_name": "string",
  "integration_record_id": "string",
  "synced_from_integration_at": "2019-08-24T14:15:22Z",
  "po_footer_notes": "string",
  "include_expected_stock": "false",
  "include_processing_stock": "false",
  "include_on_hand_stock": "false",
  "add_overage": "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 '/v1/programs/' \
--header 'Content-Type: application/json' \
--header 'Authorization;' \
--data-raw '{
    "name": "string",
    "reference_number": "string",
    "production_date": "2019-08-24",
    "notes": "string",
    "approved": false,
    "metadata": {},
    "lines": [],
    "synced_from_integration": true,
    "integration_source_name": "string",
    "integration_record_id": "string",
    "synced_from_integration_at": "2019-08-24T14:15:22Z",
    "po_footer_notes": "string",
    "include_expected_stock": "false",
    "include_processing_stock": "false",
    "include_on_hand_stock": "false",
    "add_overage": "true"
}'

Responses

🟢200Success
application/json
Body
id
string <uuid>
Id
read-onlyrequired
name
string  | null 
Name
required
<= 255 characters
reference_number
string  | null 
Reference number
required
<= 255 characters
approved
string 
Approved
read-onlyrequired
production_date
string <date> | null 
Production date
required
production_location 
string 
required
Name of production location
notes
string  | null 
Notes
required
>= 1 characters
metadata
object  | null 
Metadata
required
org_id
string 
Org id
read-onlyrequired
lines
array[object (ProgramLine) {2}] 
read-onlyrequired
quant
integer 
Quant
required
>= -2147483648<= 2147483647
bom
object (Boms) 
required
synced_from_integration
boolean 
required
integration_source_name
string  | null 
required
integration_record_id
string  | null 
required
synced_from_integration_at
string <date-time> | null 
required
Example
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "reference_number": "string",
  "approved": "string",
  "production_date": "2019-08-24",
  "production_location ": "string",
  "notes": "string",
  "metadata": {},
  "org_id": "string",
  "lines": [
    {
      "quant": -2147483648,
      "bom": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "version": "string",
        "part_number": "string",
        "approved": "string",
        "metadata": {},
        "org_id": "string",
        "data_source": "string",
        "synced_from_integration": false,
        "synced_from_integration_at": "2019-08-24T14:15:22Z",
        "integration_source_name": "string",
        "integration_record_id": "string"
      }
    }
  ],
  "synced_from_integration": true,
  "integration_source_name": "string",
  "integration_record_id": "string",
  "synced_from_integration_at": "2019-08-24T14:15:22Z"
}
Modified at 2024-08-23 10:54:43
Previous
Gets Programs
Next
Gets a Program
Built with