Skip to main content
POST
Create a vendor

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Create a new vendor

name
string
required
emails
string[]
address
object
type
enum<string>
Available options:
BUSINESS,
INDIVIDUAL
syncToQbo
boolean

When true and your account has QuickBooks Online connected, the vendor is also created in QuickBooks. Defaults to false (the vendor exists only in Nickel).

Response

Successful operation

id
string
name
string | null
emails
string[]
address
string | null
city
string | null
state
string | null
zip
string | null
type
string | null
vendorDeliveryMethods
object[]

The vendor's delivery methods.

vendorPayoutMethods
object[]
deprecated

Deprecated alias of vendorDeliveryMethods, retained for backwards compatibility.