{
"name": "Best Foods Co.",
"code": "BEST-FOODS",
"external_supplier_id": "SUP-001",
"email": "orders@bestfoods.com",
"tax_id": "12-3456789",
"external_user_id": "user_admin_01"
}
{
"id": "sup_01j5k...",
"account_id": "acc_01j5k...",
"external_supplier_id": "SUP-001",
"code": "BEST-FOODS",
"name": "Best Foods Co.",
"email": "orders@bestfoods.com",
"phone": null,
"tax_id": "12-3456789",
"is_active": true,
"metadata": {},
"created_at": "2026-08-07T14:30:00.000Z",
"updated_at": "2026-08-07T14:30:00.000Z"
}
{
"error": {
"kind": "supplier_external_id_conflict",
"message": "A supplier with this external_supplier_id already exists"
}
}
Suppliers
Create a supplier
Creates a new supplier. Suppliers are referenced in goods receipts and purchase orders.
POST
/
api
/
v1
/
public
/
vendors
/
{vendorId}
/
identity
/
suppliers
{
"name": "Best Foods Co.",
"code": "BEST-FOODS",
"external_supplier_id": "SUP-001",
"email": "orders@bestfoods.com",
"tax_id": "12-3456789",
"external_user_id": "user_admin_01"
}
{
"id": "sup_01j5k...",
"account_id": "acc_01j5k...",
"external_supplier_id": "SUP-001",
"code": "BEST-FOODS",
"name": "Best Foods Co.",
"email": "orders@bestfoods.com",
"phone": null,
"tax_id": "12-3456789",
"is_active": true,
"metadata": {},
"created_at": "2026-08-07T14:30:00.000Z",
"updated_at": "2026-08-07T14:30:00.000Z"
}
{
"error": {
"kind": "supplier_external_id_conflict",
"message": "A supplier with this external_supplier_id already exists"
}
}
string
required
BOH API key with
catalog:write scope.string
required
Vendor UUID.
string
required
Supplier display name.
string
Short alphanumeric code.
string
Your system’s supplier identifier. Must be unique within the account.
string
Contact email.
string
Contact phone.
string
Tax/fiscal identifier.
object
Free-form extra data.
string
Actor for audit trail.
{
"name": "Best Foods Co.",
"code": "BEST-FOODS",
"external_supplier_id": "SUP-001",
"email": "orders@bestfoods.com",
"tax_id": "12-3456789",
"external_user_id": "user_admin_01"
}
{
"id": "sup_01j5k...",
"account_id": "acc_01j5k...",
"external_supplier_id": "SUP-001",
"code": "BEST-FOODS",
"name": "Best Foods Co.",
"email": "orders@bestfoods.com",
"phone": null,
"tax_id": "12-3456789",
"is_active": true,
"metadata": {},
"created_at": "2026-08-07T14:30:00.000Z",
"updated_at": "2026-08-07T14:30:00.000Z"
}
{
"error": {
"kind": "supplier_external_id_conflict",
"message": "A supplier with this external_supplier_id already exists"
}
}