Create Vendor | Coperniq API

Create a new vendor.

Required fields:

name: Vendor name
vendorType: One of CONSULTANT, FINANCING, LOGISTICS, MANUFACTURER, SUBCONTRACTOR, SUPPLIER

Optional fields:

address: Array containing a single string for the full vendor location/address
website: Vendor website URL (max 2048 chars)
description: Vendor description
isActive: Whether the vendor is active (default: true)
contacts: Array of contact IDs to associate
projectIds: Array of project IDs to link this vendor to
custom: Custom fields object

Create a new vendor. Required fields: - `name`: Vendor name - `vendorType`: One of `CONSULTANT`, `FINANCING`, `LOGISTICS`, `MANUFACTURER`, `SUBCONTRACTOR`, `SUPPLIER` Optional fields: - `address`: Array containing a single string for the full vendor location/address - `website`: Vendor website URL (max 2048 chars) - `description`: Vendor description - `isActive`: Whether the vendor is active (default: true) - `contacts`: Array of contact IDs to associate - `projectIds`: Array of project IDs to link this vendor to - `custom`: Custom fields object

Authentication

x-api-keystring

API Key authentication via header

Query parameters

allow_new_optionsbooleanOptionalDefaults to false

Whether to allow creation of new dropdown options during record creation

Request

This endpoint expects an object.

namestringRequired1-500 characters

Vendor name

vendorTypeenumRequired

The type of vendor

addresslist of stringsOptional

An array containing a single string, which represents the full vendor location/address.

websitestring or nullOptional<=2048 characters

Vendor website URL

descriptionstring or nullOptional

Vendor description

isActivebooleanOptionalDefaults to true

Whether the vendor is active

contactslist of integers or nullOptional

Contact IDs to associate with this vendor

projectIdslist of integers or nullOptional

Project IDs to link this vendor to

custommap from strings to anyOptional

Custom fields

Response

Matching vendor found (upsert)

idinteger

Unique identifier

createdAtstringformat: "date-time"

Creation timestamp

updatedAtstringformat: "date-time"

Last update timestamp

namestring

Vendor name

descriptionstring or null

Vendor description

addresslist of strings

Vendor location/address

isActiveboolean

Whether the vendor is active

primaryEmailstring or nullformat: "email"

Primary contact email

primaryPhonestring or null

Primary contact phone

numberinteger

Vendor number (e.g., 1234)

vendorTypeenum or null

The type of vendor

websitestring or null

Vendor website URL

projectIdslist of integers

IDs of projects this vendor is linked to

custommap from strings to any

Custom fields

Errors

400

Bad Request Error

401

Unauthorized Error

1	const url = 'https://api.coperniq.io/v1/vendors';
2	const options = {
3	method: 'POST',
4	headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
5	body: '{"name":"string","vendorType":"CONSULTANT"}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}

1	{
2	"id": 1,
3	"createdAt": "2024-01-15T09:30:00Z",
4	"updatedAt": "2024-01-15T09:30:00Z",
5	"name": "string",
6	"description": "string",
7	"address": [
8	"string"
9	],
10	"isActive": true,
11	"primaryEmail": "string",
12	"primaryPhone": "string",
13	"number": 1,
14	"vendorType": "CONSULTANT",
15	"website": "string",
16	"projectIds": [
17	1
18	],
19	"custom": {}
20	}