Skip to main content

supplyRegisterSupplier

Registers a new supplier in the supply chain management system for the current company context.

Authentication & Permissions​

Requires the supply:register_supplier permission to execute this mutation.

Business Rules​

  • Supplier names must be unique within each company
  • Supplier handles must be unique within each company when provided
  • The company context must exist and be accessible
  • Email addresses are validated for proper format when provided
  • Website URLs must use HTTP or HTTPS protocol when provided

Common Errors​

  • **Validation Error**: Supplier name already exists for this company
  • **Validation Error**: Supplier handle already exists for this company
  • **Validation Error**: Company context not found or inaccessible
  • **Permission Error**: Missing required supply:register_supplier permission
  • **Format Error**: Invalid email or website URL format

Status Management​

Suppliers default to "active" status unless explicitly set to "inactive". Only active suppliers appear in most supply chain operations.

supplyRegisterSupplier(
  input: RegisterSupplierInput!
): SupplySupplier!

Arguments​

supplyRegisterSupplier.input ● RegisterSupplierInput! non-null input common​

Parameters for RegisterSupplier

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.