Create vendor

POST /api/v1/vendors

Add a new supplier/vendor.

Operation ID: create_vendor_api_v1_vendors_post · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Request body

Schema: VendorCreateRequest

name string required: Vendor name (company or individual).
email string · email required: Vendor email for communications.
address string: Vendor business address.
phone string: Vendor phone number.
tax_id string: Tax identification number (EIN, VAT, etc.).
website string: Vendor website URL.
notes string: Internal notes about this vendor.
credit_limit_cents integer: Credit limit in cents.
default_payment_term_id string: Default payment term ID for new bills.
status CounterpartyStatus CounterpartyStatus: Vendor status (active, inactive, blocked).
category string: Business category (e.g., 'Raw Materials', 'Services').

Responses

201 Successful Response

Schema: VendorResponse

id string required: Vendor UUID.
business_id string required: Business UUID.
name string required: Vendor name.
email string: Vendor email address.
address string: Vendor business address.
phone string: Vendor phone number.
tax_id string: Tax identification number.
website string: Vendor website URL.
notes string: Internal notes.
credit_limit_cents integer: Credit limit in cents.
default_payment_term_id string: Default payment term ID.
status string: Vendor status.
category string: Business category.
default_location_id string: Default ship-from location ID for purchase orders.
default_location_name string: Default ship-from location name (resolved).
is_deleted boolean: Whether vendor is soft deleted.
deleted_at string · date-time: Timestamp when vendor was deleted.
created_at string · date-time required: Creation timestamp.
updated_at string · date-time required: Last update timestamp.
contacts array · VendorContactResponse: Vendor contacts.

400 Bad Request - Invalid input

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

POST /api/v1/vendors

bash

curl -X POST 'https://api.ondayzero.com/api/v1/vendors' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "email": "string"
}'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/vendors', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "name": "string",
  "email": "string"
}),
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {
  "name": "string",
  "email": "string"
}

response = httpx.post("https://api.ondayzero.com/api/v1/vendors", headers=headers, json=payload)
data = response.json()