Update a supplier

{
  "email": "newemail@bestfoods.com",
  "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": "newemail@bestfoods.com",
  "is_active": true,
  "metadata": {},
  "updated_at": "2026-08-07T15:00:00.000Z"
}

PATCH

api

public

vendors

{vendorId}

identity

suppliers

{supplierId}

{
  "email": "newemail@bestfoods.com",
  "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": "newemail@bestfoods.com",
  "is_active": true,
  "metadata": {},
  "updated_at": "2026-08-07T15:00:00.000Z"
}

string

required

BOH API key with catalog:write scope.

string

required

Vendor UUID.

string

required

Supplier UUID.

string

New display name.

string

New short code.

string

New external identifier.

string

New contact email.

string

New contact phone.

string

New tax/fiscal identifier.

object

Replaces the existing metadata object.

string

Actor for audit trail.

{
  "email": "newemail@bestfoods.com",
  "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": "newemail@bestfoods.com",
  "is_active": true,
  "metadata": {},
  "updated_at": "2026-08-07T15:00:00.000Z"
}

Overview

Identity

Stores

Suppliers

Catalog Items

Catalog Sync

Recipes

Goods Receipts

Stock Counts

Waste Events

Transfers

Production Batches

Tracking

Par Levels

Suggested Order

Purchase Orders

PO Lines

Webhooks