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

Gets Program Availabilities

GET
/v1/programs/{programs_id}/availabilities/
Production Runs

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Path Params
programs_id
string 
required
Query Params
purchase_rule_id
string 
optional
The ID of the purchase rule you wish to use with these availabilities. Defaults to the API Key's Orgs default rule.

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/programs//availabilities/?purchase_rule_id=' \
--header 'Authorization;'

Responses

🟢200Success
application/json
Body
total_lines
integer 
Total lines
required
inventory_lines
integer 
Inventory lines
required
allocated_lines
integer 
Allocated lines
required
buyable_lines
integer 
Buyable lines
required
quotable_lines
integer 
Quotable lines
required
maybe_lines
integer 
Maybe lines
required
need_to_find_lines
integer 
Need to find lines
required
summary
array[object (PartSummary) {8}] 
required
request_line_id
string <uuid> | null 
Request line id
required
request_line_ids
array[string <uuid>] | null 
required
status
enum<string> 
Status
required
Allowed values:
inventoryquotablemaybeneed_to_findbuyableallocated
id
string 
Id
required
>= 1 characters
quant
integer 
Quant
required
total_quant
integer 
Total quant
required
purchase_quant
integer 
Purchase quant
required
minimum_lead
integer 
Minimum lead
required
options
array[object (PriceOption) {13}] 
required
lead
integer 
Lead
required
foreign
boolean 
Foreign
required
total_price
number 
Total price
required
landed_price
number 
Landed price
required
total_lines
integer 
Total lines
required
inventory_lines
integer 
Inventory lines
required
allocated_lines
integer 
Allocated lines
required
buyable_lines
integer 
Buyable lines
required
quotable_lines
integer 
Quotable lines
required
maybe_lines
integer 
Maybe lines
required
need_to_find_lines
integer 
Need to find lines
required
line_items_detailed
array[object (LineItem) {6}] 
required
parts
array[object (PartOption) {12}] 
required
Example
{
  "total_lines": 0,
  "inventory_lines": 0,
  "allocated_lines": 0,
  "buyable_lines": 0,
  "quotable_lines": 0,
  "maybe_lines": 0,
  "need_to_find_lines": 0,
  "summary": [
    {
      "request_line_id": "5a9a805c-f958-45a0-bb67-af51a212a00b",
      "request_line_ids": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "status": "inventory",
      "id": "string",
      "quant": 0,
      "total_quant": 0,
      "purchase_quant": 0,
      "minimum_lead": 0
    }
  ],
  "options": [
    {
      "lead": 0,
      "foreign": true,
      "total_price": 0,
      "landed_price": 0,
      "total_lines": 0,
      "inventory_lines": 0,
      "allocated_lines": 0,
      "buyable_lines": 0,
      "quotable_lines": 0,
      "maybe_lines": 0,
      "need_to_find_lines": 0,
      "line_items_detailed": [
        {
          "description": "string",
          "price": 0,
          "quant": 0,
          "unit_price": 0,
          "line_type": "string",
          "part_id": "string"
        }
      ],
      "parts": [
        {
          "request_line_id": "5a9a805c-f958-45a0-bb67-af51a212a00b",
          "status": "inventory",
          "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"
          },
          "quant": 0,
          "total_quant": 0,
          "purchase_quant": 0,
          "unit_price": 0,
          "total_price": 0,
          "landed_price": 0,
          "minimum_lead": 0,
          "breakdown": [
            {
              "source_id": "string",
              "source_name": "string",
              "id": "string",
              "purchase_quant": 0,
              "unit_price": 0,
              "total_price": 0,
              "landed_price": 0,
              "part_quote_id": "980417fd-33c5-4c51-9bdb-4adbb467b734",
              "is_backordered": true,
              "is_uncertain_lead": true,
              "expected_ships_in": 0,
              "expected_transit_time": 0,
              "best_case_lead": 0,
              "returnable_until": "2019-08-24",
              "release_deadline": "2019-08-24",
              "package": "tube",
              "availability": {
                "stock": 0,
                "lead": 0,
                "multiple": 0,
                "moq": 0
              }
            }
          ]
        }
      ]
    }
  ]
}
Modified at 2024-08-23 10:54:43
Previous
Deletes a Program
Next
Gets Program Availabilities Async
Built with