Vendors - BuildingSwell API

Base path: /vendor (relative to your instance’s /api/v2). The standard endpoints provide reads and writes, subject to the constraints below. Search columns: name, code, identifier

Fields

Field	Type	Notes
`id`	uuid	Unique record ID. Optional on create; see constraints below.
`organizationId`	uuid	Organization from your API key. Read-only.
`createdAt`	date-time	Read-only.
`updatedAt`	date-time	Read-only.
`isArchived`	boolean	Optional on create; see constraints below.
`archivedAt`	date-time \| null	Read-only.
`name`	string	Required on create.
`identifier`	string	Optional on create; see constraints below.
`code`	string \| null	Optional on create; see constraints below.
`type`	string	`supplier`, `manufacturer`, `subcontractor`. Optional on create; see constraints below.
`status`	string	`active`, `inactive`. Optional on create; see constraints below.
`website`	string \| null	Optional on create; see constraints below.
`addressLine1`	string \| null	Optional on create; see constraints below.
`addressLine2`	string \| null	Optional on create; see constraints below.
`city`	string \| null	Optional on create; see constraints below.
`stateOrProvince`	string \| null	Optional on create; see constraints below.
`postalCode`	string \| null	Optional on create; see constraints below.
`country`	string \| null	`US`, `CA`. Optional on create; see constraints below.
`defaultLeadTimeDays`	integer \| null	Optional on create; see constraints below.
`metadata`	object	Optional on create; see constraints below.

Only name is required on create. type is supplier, manufacturer, or subcontractor; status is active or inactive. Contacts are separate records linked by vendorId. Item-specific supplier SKUs live in item vendors.

Archive and restore

DELETE archives this resource. Restore it with PATCH /vendor/{id} and { "isArchived": false }. See archiving and deleting.