Cofactr Platform API
  1. Suppliers
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
      POST
    • Update Supplier
      PATCH
    • Get Supplier
      GET
    • Get Suppliers
      GET
  • 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. Suppliers

Update Supplier

PATCH
/v1/suppliers/{supplier_id}/
Updates a supplier used for the given organization.

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Path Params
supplier_id
string 
required
Body Params application/json
synced_from_integration
boolean 
Synced from integration
optional
integration_source_name
string 
Integration source name
optional
integration_record_id
string 
Integration record id
optional
synced_from_integration_at
string <date-time>
Synced from integration at
optional
metadata
object 
Metadata
optional
notes
string 
Notes
optional
>= 1 characters
component_cloud_id
string 
Component cloud id
optional
>= 1 characters<= 255 characters
connection_type
enum<string> 
Connection type
optional
Allowed values:
supplier_networkcofactr_paydirect
use_pricing_api
boolean 
Use pricing api
optional
use_order_submission_api
boolean 
Use order submission api
optional
use_order_status_api
boolean 
Use order status api
optional
use_order_po
boolean 
Use order po
optional
use_online_checkout
boolean 
Use online checkout
optional
use_custom_reeling
boolean 
Use custom reeling
optional
allow_non_part_purchase_lines
boolean 
Allow non part purchase lines
optional
automatically_generate_purchases
boolean 
Automatically generate purchases
optional
automatically_add_requests_to_open_purchases
boolean 
Automatically add requests to open purchases
optional
automatically_approve_purchases
boolean 
Automatically approve purchases
optional
automatically_send_purchases
boolean 
Automatically send purchases
optional
po_footer_notes
string 
Po footer notes
optional
>= 1 characters
invoice_approval
enum<string> 
Invoice approval
optional
Allowed values:
defaultneveralwaystwo_way_matchthree_way_match
name
string 
Name
required
>= 1 characters<= 255 characters
alt_names
array[string]
optional
website
string 
Website
optional
>= 1 characters<= 255 characters
contact_name
string 
optional
phone
string 
Phone
optional
>= 1 characters<= 255 characters
order_email
string 
Order email
optional
>= 1 characters<= 255 characters
quoting_email
string 
Quoting email
optional
>= 1 characters<= 255 characters
payment_email
string 
Payment email
optional
>= 1 characters<= 255 characters
custom_reel_price
string <decimal>
Custom reel price
optional
additional_fee_flat
string <decimal>
Additional fee flat
optional
additional_fee_percentage
string <decimal>
Additional fee percentage
optional
minimum_line_size
string <decimal>
Minimum line size
optional
minimum_order_size
string <decimal>
Minimum order size
optional
minimum_order_for_scheduled_release
string <decimal>
Minimum order for scheduled release
optional
minimum_line_for_scheduled_release
string <decimal>
Minimum line for scheduled release
optional
shipping_options
object 
Shipping options
optional
free_ship
object 
Free ship
optional
us_shipping_methods
object 
Us shipping methods
optional
international_shipping_methods
object 
International shipping methods
optional
allow_dropship
boolean 
Allow dropship
optional
certifications
array[string]
optional
best_case_lead
integer 
Best case lead
optional
scheduled_release_period
integer 
Scheduled release period
optional
convenience_return_window
integer 
Convenience return window
optional
uncertain_lead
boolean 
Uncertain lead
optional
ships_in_lead
integer 
Ships in lead
optional
buyable
boolean 
Buyable
optional
custom_properties
object 
optional
Example
{
  "synced_from_integration": true,
  "integration_source_name": "string",
  "integration_record_id": "string",
  "synced_from_integration_at": "2019-08-24T14:15:22Z",
  "metadata": {},
  "notes": "string",
  "component_cloud_id": "string",
  "connection_type": "supplier_network",
  "use_pricing_api": true,
  "use_order_submission_api": true,
  "use_order_status_api": true,
  "use_order_po": true,
  "use_online_checkout": true,
  "use_custom_reeling": true,
  "allow_non_part_purchase_lines": true,
  "automatically_generate_purchases": true,
  "automatically_add_requests_to_open_purchases": true,
  "automatically_approve_purchases": true,
  "automatically_send_purchases": true,
  "po_footer_notes": "string",
  "invoice_approval": "default",
  "name": "string",
  "alt_names": [],
  "website": "string",
  "contact_name": "string",
  "phone": "string",
  "order_email": "string",
  "quoting_email": "string",
  "payment_email": "string",
  "custom_reel_price": "string",
  "additional_fee_flat": "string",
  "additional_fee_percentage": "string",
  "minimum_line_size": "string",
  "minimum_order_size": "string",
  "minimum_order_for_scheduled_release": "string",
  "minimum_line_for_scheduled_release": "string",
  "shipping_options": {},
  "free_ship": {},
  "us_shipping_methods": {},
  "international_shipping_methods": {},
  "allow_dropship": true,
  "certifications": [],
  "best_case_lead": 0,
  "scheduled_release_period": 0,
  "convenience_return_window": 0,
  "uncertain_lead": true,
  "ships_in_lead": 0,
  "buyable": true,
  "custom_properties": {}
}

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 PATCH '/v1/suppliers//' \
--header 'Content-Type: application/json' \
--header 'Authorization;' \
--data-raw '{
    "synced_from_integration": true,
    "integration_source_name": "string",
    "integration_record_id": "string",
    "synced_from_integration_at": "2019-08-24T14:15:22Z",
    "metadata": {},
    "notes": "string",
    "component_cloud_id": "string",
    "connection_type": "supplier_network",
    "use_pricing_api": true,
    "use_order_submission_api": true,
    "use_order_status_api": true,
    "use_order_po": true,
    "use_online_checkout": true,
    "use_custom_reeling": true,
    "allow_non_part_purchase_lines": true,
    "automatically_generate_purchases": true,
    "automatically_add_requests_to_open_purchases": true,
    "automatically_approve_purchases": true,
    "automatically_send_purchases": true,
    "po_footer_notes": "string",
    "invoice_approval": "default",
    "name": "string",
    "alt_names": [],
    "website": "string",
    "contact_name": "string",
    "phone": "string",
    "order_email": "string",
    "quoting_email": "string",
    "payment_email": "string",
    "custom_reel_price": "string",
    "additional_fee_flat": "string",
    "additional_fee_percentage": "string",
    "minimum_line_size": "string",
    "minimum_order_size": "string",
    "minimum_order_for_scheduled_release": "string",
    "minimum_line_for_scheduled_release": "string",
    "shipping_options": {},
    "free_ship": {},
    "us_shipping_methods": {},
    "international_shipping_methods": {},
    "allow_dropship": true,
    "certifications": [],
    "best_case_lead": 0,
    "scheduled_release_period": 0,
    "convenience_return_window": 0,
    "uncertain_lead": true,
    "ships_in_lead": 0,
    "buyable": true,
    "custom_properties": {}
}'

Responses

🟢200Success
application/json
Body
id
string <uuid>
required
metadata
object 
required
synced_from_integration
boolean 
required
synced_from_integration_at
string <date-time>
required
integration_source_name
string 
required
integration_record_id
string 
required
notes
string 
required
org
string <uuid>
required
component_cloud_id
string 
required
connection_type
string 
required
use_pricing_api
boolean 
required
use_order_submission_api
boolean 
required
use_order_status_api
boolean 
required
use_order_po
boolean 
required
use_online_checkout
boolean 
required
use_custom_reeling
boolean 
required
allow_non_part_purchase_lines
boolean 
required
automatically_generate_purchases
boolean 
required
automatically_add_requests_to_open_purchases
boolean 
required
automatically_approve_purchases
boolean 
required
automatically_send_purchases
boolean 
required
po_footer_notes
string 
required
invoice_approval
string 
required
name
string 
required
contact_name
string 
required
alt_names
array[string]
required
website
string 
required
phone
string 
required
order_email
string 
required
quoting_email
string 
required
payment_email
string 
required
custom_reel_price
number 
required
additional_fee_flat
number 
required
additional_fee_percentage
number 
required
minimum_line_size
number 
required
minimum_order_size
number 
required
minimum_order_for_scheduled_release
number 
required
minimum_line_for_scheduled_release
number 
required
shipping_options
object 
required
free_ship
object 
required
us_shipping_methods
object 
required
international_shipping_methods
object 
required
allow_dropship
boolean 
required
certifications
array[string]
required
best_case_lead
integer 
required
scheduled_release_period
integer 
required
convenience_return_window
integer 
required
uncertain_lead
boolean 
required
ships_in_lead
integer 
required
buyable
boolean 
required
custom_properties
object 
required
Example
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "metadata": {},
  "synced_from_integration": true,
  "synced_from_integration_at": "2019-08-24T14:15:22Z",
  "integration_source_name": "string",
  "integration_record_id": "string",
  "notes": "string",
  "org": "3b4eb1f5-aaca-43c1-9ccf-5bbd44308aba",
  "component_cloud_id": "string",
  "connection_type": "string",
  "use_pricing_api": true,
  "use_order_submission_api": true,
  "use_order_status_api": true,
  "use_order_po": true,
  "use_online_checkout": true,
  "use_custom_reeling": true,
  "allow_non_part_purchase_lines": true,
  "automatically_generate_purchases": true,
  "automatically_add_requests_to_open_purchases": true,
  "automatically_approve_purchases": true,
  "automatically_send_purchases": true,
  "po_footer_notes": "string",
  "invoice_approval": "string",
  "name": "string",
  "contact_name": "string",
  "alt_names": [
    "string"
  ],
  "website": "string",
  "phone": "string",
  "order_email": "string",
  "quoting_email": "string",
  "payment_email": "string",
  "custom_reel_price": 0,
  "additional_fee_flat": 0,
  "additional_fee_percentage": 0,
  "minimum_line_size": 0,
  "minimum_order_size": 0,
  "minimum_order_for_scheduled_release": 0,
  "minimum_line_for_scheduled_release": 0,
  "shipping_options": {},
  "free_ship": {},
  "us_shipping_methods": {},
  "international_shipping_methods": {},
  "allow_dropship": true,
  "certifications": [
    "string"
  ],
  "best_case_lead": 0,
  "scheduled_release_period": 0,
  "convenience_return_window": 0,
  "uncertain_lead": true,
  "ships_in_lead": 0,
  "buyable": true,
  "custom_properties": {}
}
Modified at 2024-08-23 04:07:28
Previous
Create Supplier
Next
Get Supplier
Built with