Skip to main content
POST
Create a vendor

Authorizations

Authorization
string
header
required

OAuth 2.0 with opaque bearer tokens. Authorization-code requests require PKCE S256.

Headers

X-API-Version
string

Pin a dated API release (YYYY-MM-DD). Omit for the latest (2026-06-09). Unknown values return 400 unsupported_api_version; the resolved version is echoed back in the X-API-Version response header.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-06-09"

Body

application/json
vendor_name
string
vendor_aliases
string[]
contact_info
string
address
string
note
string
external_vendor_id
string
accounting_vendor_remote_id
string
accounting_vendor_contact_remote_id
string
vendor_type
string
is_active
boolean
country
string
Required string length: 2
state
string
billing_frequency
string
federal_tax_classification
string
payment_terms
string
currency
string
Example:

"USD"

default_markup_percent
number
dock_hours
string
delivery_schedule
object
order_cutoff
object
return_email_enabled
boolean
return_contact_email
string<email>

Response

Vendor created.