Suppliers
List Suppliers
List all suppliers with list support. Supports filtering, sorting, and pagination.
Show Supplier
Returns a single supplier. The response includes the supplier's address, default payment term, default shipping method, default incoterm, and warehouses (each with its address) by default.
List Suppliers
List all suppliers with list view support. Supports filtering, sorting, and pagination.
Create Supplier
Create a new supplier. Automatically creates a default warehouse for the supplier and attaches default pricing tiers.
Bulk Delete Suppliers
Bulk delete suppliers by IDs or by applying to all filtered results.
Get Supplier (with Warehouses)
Get a single supplier with warehouses loaded.
Update Supplier
Update an existing supplier. All fields are optional.
Delete Supplier
Delete a supplier. Returns 400 if the supplier is linked to purchase orders or other records. Deleting a supplier also removes its owned records, including its custom field values.
Set Supplier WhatsApp Contact
Designate which of the supplier's contacts is its WhatsApp/SMS contact. The supplier's messaging number is synced to that contact's phone. Send `contact_id: null` to clear the designation (the stored number is kept). Returns the updated supplier.
Merge Suppliers
Merge one supplier into another. The supplier in the URL is the **source**: all of its records are re-pointed to the target, and the source is then **permanently deleted**. **This operation is irreversible — there is no undo.**
Get Supplier Activity Log
Rolled-up activity timeline for a single supplier. Returns the supplier's own field changes plus related activity across its purchase orders (and their lines and invoices), vendor credits (and their lines and shipments), vendor deposits, bills, and supplier products (and pricing). Results are paginated and ordered newest-first.
Archive Supplier
Archive a single supplier.
Unarchive Supplier
Unarchive a previously archived supplier.
Download PO CSV Sample
**Legacy proxy.** Generate and download a 3-row sample CSV showing exactly which columns will be included in this supplier's outgoing PO email attachment.
Download PO Sample (CSV/XLSX)
Generate and download a 3-row sample of the file the supplier will receive when this PO is submitted. Supports both CSV and XLSX (controlled by `format`). Backs the per-supplier PO file attachment column picker so users can preview the layout before saving.
Bulk Archive Suppliers
Bulk archive suppliers by IDs or by applying to all filtered results.
Bulk Unarchive Suppliers
Bulk unarchive suppliers by IDs or by applying to all filtered results.
List Supplier Products
Retrieve all products linked to a supplier. Supports search by supplier SKU, product SKU, or name (using Typesense with SQL fallback).
Get Supplier Products Stock
Get stock levels for specific products from a supplier's perspective.
Get Supplier Pricing Tiers
List pricing tiers attached to a supplier using Spatie QueryBuilder (filter[key]=value bracket format).
Attach Pricing Tier to Supplier
Attach an existing pricing tier to a supplier.
Detach Pricing Tier from Supplier
Delete a pricing tier from a supplier. Cannot delete default or linked pricing tiers.
Get Supplier Warehouses
Get all warehouses associated with a supplier, with list view support.
Create Supplier Warehouse
Create a new warehouse for a supplier. Automatically initializes supplier inventory for the new warehouse. If this is the supplier's first warehouse (or is_default is true), it becomes the default warehouse.
Get Warehouse Linked Orders
Get the count of open purchase orders linked to a warehouse. Used before deleting a warehouse to check for dependencies.
Preview Supplier Import
Preview a supplier import from a CSV file.
Import Suppliers
Import suppliers from a CSV file.
Preview Supplier Inventory Import
Preview supplier inventory import from a CSV file.
Import Supplier Inventory
Import inventory levels for a specific supplier from a CSV file.
Export Suppliers
Export the supplier list as a spreadsheet file. Synchronous — the response body is the file itself (`text/csv` or, with `format=xlsx`, an Excel workbook) named `suppliers-{timestamp}.{format}`.
Request Invoices (Consolidated)
Send a supplier one consolidated email requesting the outstanding invoices for several purchase orders at once. Each selected PO is re-validated server-side: it must belong to this supplier AND still be awaiting its invoice — ineligible ids are skipped and reported back (not emailed). Every PO that IS sent is stamped (invoice_requested_at, invoice_request_count++, invoice_last_requested_by).
Manage Invoice Reminders
Set the automated invoice-reminder mode for a purchase order: inherit (use the supplier/tenant setting), on, or off. Setting on arms the recurring chase when the PO is still awaiting its invoice; off stops it.
Update Supplier Invoice Reminders
Update a supplier's automated invoice-reminder settings — the mode plus optional cadence overrides. These resolve above the tenant default and below any per-PO override.
Verify Supplier Bank Details
Mark this supplier's wire instructions as verified out-of-band (for example, confirmed by phone with a known contact). Records who verified them and when, and clears the non-blocking bank-details warning shown when authorizing payment on the supplier's bills.
Unverify Supplier Bank Details
Clear a previous out-of-band verification of this supplier's wire instructions. The bank-details warning reappears on the supplier's bills until the details are verified again.
Check Suppliers Deletable
Check which suppliers can be deleted before performing bulk delete.
Create Supplier Product
Creates a new supplier product relationship (a product sold by a specific supplier).
Get Supplier Product
Returns full details for a supplier product including product, supplier, pricing tiers, and inventory levels per warehouse.
Update Supplier Product
Updates an existing supplier product.
Delete Supplier Product
Deletes a supplier product and its associated inventories.
Get Supplier Product Activity Log
Returns paginated activity log for a supplier product.
Get Supplier Product Notes
Returns paginated notes for a supplier product, most recent first.
Add Supplier Product Note
Adds a note to a supplier product.
Delete Supplier Product Note
Deletes a note from a supplier product.
Update Pricing Tiers
Updates pricing tiers for a supplier product.
List Supplier Pricing Tiers
Returns a paginated list of supplier pricing tiers.
Create Supplier Pricing Tier
Creates a new supplier pricing tier.
Bulk Delete Pricing Tiers
Bulk deletes multiple supplier pricing tiers by ID.
Get Supplier Pricing Tier
Returns a single supplier pricing tier by ID.
Update Supplier Pricing Tier
Updates an existing supplier pricing tier.
Delete Supplier Pricing Tier
Deletes a supplier pricing tier. Will fail if:
Archive Pricing Tier
Archives a supplier pricing tier. Cannot archive the default tier or a tier that is the base for active dependent tiers.
Unarchive Pricing Tier
Unarchives a supplier pricing tier.
Bulk Archive Pricing Tiers
Bulk archives multiple supplier pricing tiers. Default tiers and tiers with active dependents are skipped with warnings.
Bulk Unarchive Pricing Tiers
Bulk unarchives multiple supplier pricing tiers.
Check Supplier Pricing Tiers Deletable
Checks whether each pricing tier can be safely deleted.
Check Supplier Pricing Tiers Archivable
Checks whether each pricing tier can be archived. Default tiers cannot be archived.
Set as Default
Sets the specified pricing tier as the system default. Clears the is_default flag from the previously default tier.
Preview Pricing Tier Import
Preview the result of importing supplier pricing tiers from a CSV/Excel file without committing.
Import Pricing Tiers
Imports supplier pricing tiers from a CSV or Excel file.
List Supplier Inventories
Returns a paginated list of supplier inventory records using Spatie QueryBuilder.
List Our Inventory for Supplier
Returns a paginated list of OUR internal warehouse inventory rows for products supplied by the given supplier.
Get Our Inventory Stats for Supplier
Returns aggregate stats for OUR internal warehouse inventory of products supplied by the given supplier.
List Supplier Inventories (Lookup)
Returns a paginated list of supplier inventories via Spatie QueryBuilder. Same filter/sort support as the list view index.
Get Supplier Inventory
Returns a single supplier inventory record with related product and warehouse data.
Update Supplier Inventory
Updates a supplier inventory record. Sets source to 'user'. Provide either quantity OR in_stock (not both). On update every field is optional, so you can send a partial update — for example only `discontinued` or `eta` — without re-sending quantity/in_stock; the existing stock value is preserved.
Export Supplier Inventories
Exports all supplier inventory records for a specific supplier as a CSV or Excel file download. The supplier_id filter is automatically applied.
Archive Supplier Inventory
Archives a single supplier inventory record. Idempotent — returns a warning if already archived.
Unarchive Supplier Inventory
Unarchives a single supplier inventory record.
Bulk Archive Supplier Inventories
Bulk archives multiple supplier inventory records by ID array or current list view filters.
Bulk Unarchive Supplier Inventories
Bulk unarchives multiple supplier inventory records by ID array or current list view filters.
Check Supplier Inventories Archivable
Checks whether each provided supplier inventory ID can be safely archived.
Check Supplier Inventories Deletable
Checks whether each provided supplier inventory ID can be safely deleted.
Download Import Template
Downloads an XLSX import template for a specific supplier, pre-populated with headers, sample data, field guide, and reference data (products, warehouses) for the tenant's account.
Validate Import
Validates import data rows for a supplier without creating any records. Safe to call repeatedly for UI previewing. Resolves SKU and warehouse names against the tenant's catalogue and returns a per-row preview alongside an aggregate summary.
Execute Import
Queues a supplier inventory import — creates or updates inventory records for a specific supplier in the background.