Skip to main content

Create Supplier

POST 
/api/suppliers

Create a new supplier. Automatically creates a default warehouse for the supplier and attaches default pricing tiers.

Required scope: suppliers:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token. Requires IsPowerUserAccess middleware.

Notes:

  • email and purchase_order_email accept comma-separated multiple email addresses
  • messaging_phone: the supplier's WhatsApp/SMS number in international format (E.164, e.g. +15551234567), used to message them from a purchase order
  • name must be unique
  • po_processing_method: email, ftp, direct
  • po_batch_schedule.days: monday, tuesday, wednesday, thursday, friday, saturday, sunday
  • default_stock_level: normal, low, critical

Requires permission: suppliers.create

Clearing default_incoterm_id (sending it as null/empty) also clears default_incoterm_place — a default named place is never kept without a default term.

Custom fields: custom_field_values (optional array) sets values for supplier custom fields. Each entry takes custom_field_id (required — must reference a custom field defined for suppliers) and value (nullable); id is prohibited on create (value ids only exist once the supplier does). The response echoes each value with its field metadata: name, slug, field_type (text | long_text | number | decimal | date | datetime | checkbox | dropdown), options, description, and is_visible_in_details.

Request​

Responses​

Created

Response Headers
    Content-Type