Cofactr Platform API
  • BOMs
  • Programs
  • Account
  • Reporting
  • Email
  • Auth
  • Async Jobs
  • Stock Documents
  • Suppliers
    • Create SupplierPOST
    • Update SupplierPATCH
    • Get SupplierGET
    • Get SuppliersGET
  • Parts
  • Purchases
  • Teams
  • Custom Properties
  • Stock Lots
logoPowered by Apidog
  1. Suppliers

Update Supplier

PATCH/v1/suppliers/{supplier_id}/

Updates a supplier used for the given organization.

Request

Authorization: API Key
Add parameter in header
Authorization
Example
Authorization: 2f68dbbf-519d-4f01-9636-e2421b68f379
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
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:22.123Z",
  "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",
  "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

Responses

Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
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
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
Not configured
Last modified: 4 months ago