Skip to main content

supplyArchiveSupplier

Archive a supplier.

Archiving a supplier hides it from the default supplier list and from pickers, but leaves all historical data (purchase orders, product associations) intact. Archiving is reversible via supplyUnarchiveSupplier.

Authentication & Permissions​

Requires authentication and the supply:archive_supplier permission for the supplier's company.

Business Rules​

A supplier can always be archived, even when it is still in use. If the supplier has open purchase orders or linked products, the canBeArchived field is false and archiveWarnings describes why — but the archive is still allowed. Use those fields to warn the user before archiving.

Possible Errors​

  • **Supplier was not found**: The specified supplier does not exist
  • **Supplier does not belong to the provided company**: The supplier belongs to a different company
supplyArchiveSupplier(
  input: ArchiveSupplierInput!
): SupplySupplier!

Arguments​

supplyArchiveSupplier.input ● ArchiveSupplierInput! non-null input common​

Parameters for ArchiveSupplier

Type​

SupplySupplier object suppliers​

Represents a supplier in the supply chain management system.

Supply suppliers are external parties that provide materials, products, or services to the supply chain. Each supplier maintains comprehensive business information, performance metrics, and operational details that help with supplier management and procurement decisions.

Supplier Information​

  • **Business Details**: Name, contact information, location, and establishment year
  • **Performance Metrics**: Quality ratings, on-time delivery rates, response times
  • **Financial Terms**: Payment terms, shipping terms, tax information
  • **Operational Data**: Lead times, business hours, time zones, and Incoterms

Status Management​

Suppliers can be active or inactive, allowing for proper lifecycle management without losing historical data and relationships.

Relationships​

Each supplier belongs to a company and can be associated with multiple products and addresses for comprehensive supplier management.